Explore

Retrieve all interests

GET/engage/interests

Gets information about all interests and preferences 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": 3,
  "count": 50,
  "offset": 0,
  "results": [
    {
      "id": "59c0d81b46fc511248b0ef55",
      "name": "Book Club"
    },
    {
      "id": "55f89dcc87bb384b24acc386",
      "name": "Competitions"
    },
    {
      "id": "55f89dcc87bb384b24acc38b",
      "name": "Customer Evenings"
    }
  ]
}

Lookup a specific interest

GET/engage/interests/{id}

Gets information about a specific interest from within your CRM configuration.

Parameters

The unique id for the interest

Example response

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

{
  "id": "55f89dcc87bb384b24acc385",
  "name": "Competitions"
}

Create a new interest

POST/engage/interests

Creates a new interest within your CRM configuration.

Request body

Interest

Example request

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

{
  "name": "Experience Days"
}

Example response

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

{
  "id": "5ac38d479b04b318602a1c40",
  "name": "Experience Days"
}

Update an interest

PUT/engage/interests/{id}

Updates the settings for a specific interest.

Parameters	id	The unique id for the interest
Request body	Interest

Example request

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

{
  "name": "Experience Events"
}

Example response

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

{
  "id": "5ac38d479b04b318602a1c40",
  "name": "Experience Events"
}

Delete an interest

DELETE/engage/interests/{id}

Deletes an interest from your CRM configuration.

Parameters

The unique id for the interest

Example response

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