Linking - Contact Link

Use this method to create a link between a Contact record in Kindful and a contact record in your external application. Kindful interprets records with your application-specific ID set as "known" by your application.

This is relevant to the following other methods:

  • When querying for "new" records: records without your application-specific external ID will be assumed to be "new", and will therefore be returned. Setting the your application-specific external ID field on records that you already have in your system will prevent them from being returned in this call, thereby preventing duplication in your system.
  • Kindful will track changes to records containing a value for your application-specific external ID so that changes to those records can be returned to you upon a request for updates.

create vs update

Don't use 'create' to update the link. The sync version will not be updated if you use 'create' for action type for subsequent linking.


Transaction Link Post Request

Make a POST request to https://app-sandbox.kindful.com/admin/oauth2/api/v1/contacts/link with the following in the body:

COPY
{
  "action_type": "update",
  "data_type": "json",
  "data": [
    {
      "id": "1", 
      "external_id": "ext_12345", 
      "sync_version": "1", 
      "updated_at": "2015-10-13 18:56:12 UTC"
    },
    {
      "id": "2", 
      "external_id": "ext_12346", 
      "sync_version": "2", 
      "updated_at": "2015-10-13 18:56:12 UTC" 
    }
  ]
}

JSON vs CSV

If using JSON -- it should be a single JSON object per line.

If using CSV -- it should not include BOM field.


Body Params

BODY PARAMS
action_type
string
Specifies what action to take with the data.
data
array
an array of elements with an id for kindful identifier and an external_id for the remote id. no more than 100 per post are allowed. use data_url if more is needed
data_url
string
data_type
string
compression
string
encrypted (coming soon)
string