Explore

Retrieve all contact sources

GET/engage/sources

Gets information about all contact sources within your CRM configuration.

Querystring	count	The number of records to return
Querystring	offset	The number of records from a collection to skip

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "total": 67,
  "count": 3,
  "offset": 0,
  "results": [
    {
      "id": "55f89dc987bb384b24acc357",
      "name": "Old Customer Database"
    },
    {
      "id": "55f89dc987bb384b24acc358",
      "name": "Online Book Club"
    },
    {
      "id": "55f89dc987bb384b24acc359",
      "name": "Personal Shopper"
    }
  ]
}

Lookup a specific contact source

GET/engage/sources/{id}

Gets information about a specific contact source within your CRM configuration.

Parameters

The unique id for the contact source

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "55f89dc987bb384b24acc357",
  "name": "Old Customer Database"
}

Create a new contact source

POST/engage/sources

Creates a new contact source within your CRM configuration.

Request body

Contact Source

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Facebook"
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5ac388ea9b04b318602a1c3f",
  "name": "Facebook"
}

Update a contact source

PUT/engage/sources/{id}

Updates the settings for a specific custom field.

Parameters	id	The unique id for the contact source
Request body	Contact Source

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Facebook Retargeting"
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5ac388ea9b04b318602a1c3f",
  "name": "Facebook Retargeting"
}

Delete a contact source

DELETE/engage/sources/{id}

Deletes a contact source from your CRM configuration.

Parameters

The unique id for the contact source

Example response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8