GET https://api.engagor.com/{account_id}/inbox/contact/{contact_id}

Description

Returns a single social profile / contact.

You can fetch a contact by its contact.id, or by using service ("twitter", "facebook", ...) & service_id (id of the user on the platform). (These values are returned as contact.socialprofiles[].type and contact.socialprofiles[].service_id on contact objects.)

Required Access Token Scope

accounts_read

GET Parameters

Param Description Required Default Value
topic_ids Comma separated list of topic ids to search for details. (Optional for most types of contacts, required for contacts of type 'wechat', 'twilio', 'web', 'whatsapp', 'viber'.) No

Result

A single contact item.

POST https://api.engagor.com/{account_id}/inbox/contact/{contact_id}

Description

Updates a single social profile / contact.

You can update a contact by its contact.id, or by using service ("twitter", "facebook", ...) & service_id (id of the user on the platform). (These values are returned as contact.socialprofiles[].type and contact.socialprofiles[].service_id on contact objects.)

Required Access Token Scope

accounts_read, accounts_write

POST Parameters

Param Description Required Default Value
updates A JSON encoded array of changes you want to make. Structure of the object should be like contact, with only those properties you want to update. (Property `socialprofiles` can't be updated.) Yes
options A JSON encoded array of options for the update. Supported keys: 'customattributes_edit_mode' (possible values: 'update', 'overwrite' or 'delete'; 'update' is default), 'tags_edit_mode' (possible values: 'add', 'update', or 'delete'; 'update' is default) No
topic_ids Comma separated list of topic ids to search for details. (Optional for most types of contacts, required for contacts of type 'wechat', 'twilio', 'web', 'whatsapp', 'viber'.) No

Result

The updated contact item.

Examples

Update standard fields of a contact

Add a tag to a contact

Updating the tags of a contact

Delete a tag from a contact

Add/update a custom attribute

Delete a custom attribute

DELETE https://api.engagor.com/{account_id}/inbox/contact/{contact_id}

Description

Deletes a social profile / contact.

Required Access Token Scope

accounts_read, accounts_write

DELETE Parameters

Param Description Required Default Value
This API endpoint doesn't need any parameters.

Result

Boolean that indicates if contact details were deleted.