Create/Import Contact

Creates a Contact in Social Gateway.

POST /api/v2/contact

A Contact represents a human or company. Every Case (ticket) has a contact associated with it. Normally a Contact is a customer or someone that wants to interact with us through one or multiple channels. Contacts interact with us through their Profiles (a contact has at least one profile in the system).

Contacts can be synchronized with existing customer and lead data in CRMs or Marketing automation systems. Social Gateway provides 2 fields for this purpose:

crm_id
client_id

Using the Contacts API you can feed your CRM or Marketing tools with the activity gathered about each person in Social Networks, emails, chats and any communication channel you plugged into Social Gateway.

Input Parameters

Name Type Description
name string Required. Name of the person or company
first_name string First name of the contact
last_name string Last name of the contact
crm_id string Unique ID of the contact in the external CRM
client_id string Logical id that identifies the client company-wise. Normally the person knows this client Id (can be the same as crmId)
extended_value string Additional importa information that helps indentify the contact (normally a nick name)
note string Text note to be associated with the Case (supports multiple values)
tag string Tag to be associated with the Case (supports multiple values)
echo_data string If set to true, SG will send over a data attribute in the response with the whole newly created object.
<any_attribute_name> string Additional dynamic attributes can be added by simply passing them on.

Response Sample

Status: 200 OK
{
  "success": true,
  "contact_id": 1
}

Response Sample with echo_data

Status: 200 OK
{
  "success": true,
  "contact_id": 43,
  "data": {
    "id": 43,
    "name": "Juan Perez",
    "first_name": "Juan",
    "last_name": "Perez",
    "client_id": "4234534625",
    "extended_value": "53242354352253",
    "cases": 3,
    "profiles": [
      {
        "id": 113,
        "source": "email",
        "name": "Juan Perez",
        "ext_id": "jp@socialgateway.net",
        "user_name": "aram@socialgateway.net",
        "tags": [
          "spam"
        ],
        "creation_date": "2015-02-20T16:32:51-0300",
        "update_date": "2015-05-11T15:53:54-0300",
        "updated_by": "api"
      },
      {
        "id": 292,
        "source": "twitter",
        "name": "Juan Perez",
        "ext_id": "42416688",
        "user_name": "juanperez7010",
        "image_url": "http://pbs.twimg.com/profile_images/542701207/165901190_9e133991fb_o_normal.jpg",
        "about": "",
        "location": "Mexico",
        "followers": 436,
        "following": 2000,
        "creation_date": "2015-05-11T16:03:57-0300"
      },
      {
        "id": 5,
        "source": "facebook",
        "name": "Gatu Bela",
        "ext_id": "100003438147119",
        "user_name": "gatu.bela.129",
        "gender": "female",
        "image_url": "http://graph.facebook.com/100003438147119/picture",
        "tags": [
          "aaaee"
        ],
        "creation_date": "2015-01-08T00:39:42-0300",
        "update_date": "2015-05-11T16:04:55-0300",
        "updated_by": "support"
      }
    ],
    "url": "http://master.local2.socialgateway.net:8080/contact/43",
    "tags": [
      "spam"
    ],
    "notes": [
      {
        "date": 1431371012000,
        "text": "este cliente es ficticio",
        "userName": "support"
      }
    ],
    "creation_date": "2015-02-20T16:32:51-0300",
    "update_date": "2015-05-11T16:03:57-0300",
    "updated_by": "support"
  }
}