Clarabridge Developers | Qualtrics Social Connect

Param	Description	Required	Default Value
`mentions`	A JSON encoded array of `mention` items your want to add to your topic. (Maximum of 500.)	Yes

In the example we add a single new mention to the Qualtrics Social Connect topic 1234, with the minimal required information.

Parameters	Value plain-text formatted
`mentions`	[{"source":{"id":"1","url":"http:\/\/yoursite.com\/blog\/?id=1","category":"social"},"message":{"title":"The title of my blog post","content":"Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..."},"author":{"name":"Joe The Plumber","id":"00001","url":"http:\/\/joetheplumber.com"},"topic":{"id":1234}}] array(1) 0 => array(4) "source" => array(3) "id" => "1" "url" => "http://yoursite.com/blog/?id=1" "category" => "social" "message" => array(2) "title" => "The title of my blog post" "content" => "Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..." "author" => array(3) "name" => "Joe The Plumber" "id" => "00001" "url" => "http://joetheplumber.com" "topic" => array(1) "id" => (int) 1234

Example Response plain-text formatted
{"meta":{"code":200},"response":true} array(2) "meta" => array(1) "code" => (int) 200 "response" => true

In this example we add a mention to the Qualtrics Social Connect topic 1234 with all possible fields for a mention filled in.

Parameters	Value plain-text formatted
`mentions`	[{"source":{"url":"http:\/\/yoursite.com\/blog\/?id=1#comment_1","category":"social","domain":"yoursite.com","id":"1_1","in_reply_to_message_id":"1","profile":"category-press-releases","profile_name":"Press Releases"},"message":{"title":"Comment Title","content":"This is a test comment on a very good blog post!","language":"en","sentiment":"positive","type":"comment"},"author":{"name":"Comment Troll","id":"00003","url":"http:\/\/mywebsite.com","image":"http:\/\/mywebsite.com\/avatar.png","following":120,"followers":450},"location":{"country":"be","longitude":37.0625,"latitude":-95.677068,"region":"Oost-Vlaanderen","city":"Gent"},"date":{"published":1364232041},"topic":{"id":1234}}] array(1) 0 => array(6) "source" => array(7) "url" => "http://yoursite.com/blog/?id=1#comment_1" "category" => "social" "domain" => "yoursite.com" "id" => "1_1" "in_reply_to_message_id" => "1" "profile" => "category-press-releases" "profile_name" => "Press Releases" "message" => array(5) "title" => "Comment Title" "content" => "This is a test comment on a very good blog post!" "language" => "en" "sentiment" => "positive" "type" => "comment" "author" => array(6) "name" => "Comment Troll" "id" => "00003" "url" => "http://mywebsite.com" "image" => "http://mywebsite.com/avatar.png" "following" => (int) 120 "followers" => (int) 450 "location" => array(5) "country" => "be" "longitude" => (float) 37.0625 "latitude" => (float) -95.677068 "region" => "Oost-Vlaanderen" "city" => "Gent" "date" => array(1) "published" => (int) 1364232041 "topic" => array(1) "id" => (int) 1234

Example Response plain-text formatted
{"meta":{"code":200},"response":true} array(2) "meta" => array(1) "code" => (int) 200 "response" => true

Here we are adding two new mentions (minimal information) to the Qualtrics Social Connect topic 1234 at once.

Parameters	Value plain-text formatted
`mentions`	[{"source":{"id":"1","url":"http:\/\/yoursite.com\/blog\/?id=1","category":"social"},"message":{"title":"The title of my blog post","content":"Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..."},"author":{"name":"Joe The Plumber","id":"00001","url":"http:\/\/joetheplumber.com"},"topic":{"id":1234}},{"source":{"id":"2","url":"http:\/\/yoursite.com\/blog\/?id=2","category":"social"},"message":{"title":"The title of my second blog post","content":"Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..."},"author":{"name":"Samuel J. Wurzelbacher","id":"00002","url":"http:\/\/wurzelbacher.com\/samuel"},"topic":{"id":1234}}] array(2) 0 => array(4) "source" => array(3) "id" => "1" "url" => "http://yoursite.com/blog/?id=1" "category" => "social" "message" => array(2) "title" => "The title of my blog post" "content" => "Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..." "author" => array(3) "name" => "Joe The Plumber" "id" => "00001" "url" => "http://joetheplumber.com" "topic" => array(1) "id" => (int) 1234 1 => array(4) "source" => array(3) "id" => "2" "url" => "http://yoursite.com/blog/?id=2" "category" => "social" "message" => array(2) "title" => "The title of my second blog post" "content" => "Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..." "author" => array(3) "name" => "Samuel J. Wurzelbacher" "id" => "00002" "url" => "http://wurzelbacher.com/samuel" "topic" => array(1) "id" => (int) 1234

Example Response plain-text formatted
{"meta":{"code":200},"response":true} array(2) "meta" => array(1) "code" => (int) 200 "response" => true

Adding a mention to Qualtrics Social Connect with a URL that is already known to Qualtrics Social Connect.

Parameters	Value plain-text formatted
`mentions`	[{"source":{"id":"1","url":"http:\/\/yoursite.com\/blog\/?id=1","category":"social"},"message":{"title":"The title of my blog post","content":"Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..."},"author":{"name":"Joe The Plumber","id":"00001","url":"http:\/\/joetheplumber.com"},"topic":{"id":1234}}] array(1) 0 => array(4) "source" => array(3) "id" => "1" "url" => "http://yoursite.com/blog/?id=1" "category" => "social" "message" => array(2) "title" => "The title of my blog post" "content" => "Lorizzle rizzle dolizzle sit amet, yo adipiscing elit. ..." "author" => array(3) "name" => "Joe The Plumber" "id" => "00001" "url" => "http://joetheplumber.com" "topic" => array(1) "id" => (int) 1234

Example Response plain-text formatted
{"code":400,"error":"invalid_argument","error_description":"The mention at index 0 you provided is invalid.","error_details":{"source":{"url":["The mention at this url is already tracked."]}}} array(4) "code" => (int) 400 "error" => "invalid_argument" "error_description" => "The mention at index 0 you provided is invalid." "error_details" => array(1) "source" => array(1) "url" => array(1) 0 => "The mention at this url is already tracked."

Qualtrics Social Connect API

Endpoints » /{account_id}/inbox/add

`POST https://api-us.engagor.com/{account_id}/inbox/add`

Description

Required Access Token Scope

POST Parameters

Result

Examples