Clarabridge Developers | Qualtrics Social Connect

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.) This is not supported for Instagram.

Required Access Token Scope

GET Parameters

Result

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


							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.) This is not supported for Instagram.

Required Access Token Scope

POST Parameters

Result

Examples

Param	Description	Required
`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

This example will update the email address, name and country of a contact.

Parameters	Value plain-text formatted
`updates`	{"email":"test@example.com","name":"Roger Rabbit","address":{"country":{"code":"nl"}}} array(3) "email" => "[email protected]" "name" => "Roger Rabbit" "address" => array(1) "country" => array(1) "code" => "nl"

Add a new tag to a contact, keeping existing tags in place.

Parameters	Value plain-text formatted
`updates`	{"tags":["newtag"]} array(1) "tags" => array(1) 0 => "newtag"
`options`	{"tags_edit_mode":"add"} array(1) "tags_edit_mode" => "add"

Overwriting all existing tags of a contact with new ones.

Parameters	Value plain-text formatted
`updates`	{"tags":["newtag","newtag2"]} array(1) "tags" => array(2) 0 => "newtag" 1 => "newtag2"
`options`	{"tags_edit_mode":"update"} array(1) "tags_edit_mode" => "update"

Delete a tag from a contact, keeping other existing tags in place.

Parameters	Value plain-text formatted
`updates`	{"tags":["deleteme"]} array(1) "tags" => array(1) 0 => "deleteme"
`options`	{"tags_edit_mode":"delete"} array(1) "tags_edit_mode" => "delete"

Update the value of an existing custom attribute for a certain contact. (You can find the id of a custom attribute via the `/{account_id}/settings/customattributes` endpoint.)

Parameters	Value plain-text formatted
`updates`	{"customattributes":[{"id":1,"value":"example value"}]} array(1) "customattributes" => array(1) 0 => array(2) "id" => (int) 1 "value" => "example value"
`options`	{"customattributes_edit_mode":"update"} array(1) "customattributes_edit_mode" => "update"

Delete a custom attribute from a contact by using the `updates` and `options`. (You can find the id of a custom attribute via the `/{account_id}/settings/customattributes` endpoint.)

Parameters	Value plain-text formatted
`updates`	{"customattributes":[{"id":1}]} array(1) "customattributes" => array(1) 0 => array(1) "id" => (int) 1
`options`	{"customattributes_edit_mode":"delete"} array(1) "customattributes_edit_mode" => "delete"

Qualtrics Social Connect API

Endpoints » /{account_id}/inbox/contact/{contact_id}

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

Description

Required Access Token Scope

GET Parameters

Result

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

Description

Required Access Token Scope

POST Parameters

Result

Examples

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

Description

Required Access Token Scope

DELETE Parameters

Result