Custom Title

Parties representing people can have a title such as 'Mr' or 'Miss'. It is possible to create new custom titles and delete existing custom titles. For a full description of the model see the Custom Title model definition.

List custom titles

List custom titles for this Capsule account.

GET
https://api.capsulecrm.com/api/v2/titles

Response

Returns HTTP status code 200. The body of the response will contain an object with a single property personTitles which is an array of Title objects.

HTTP/1.1 200
{
  "personTitles" : [ {
    "id" : 8,
    "title" : "sir"
  }, {
    "id" : 9,
    "title" : "madam"
  } ]
}

Create custom title

Create a new custom title. The body must contain an object with a single property personTitle which must be a Title object. Capsule accounts can have at most 50 custom titles. This operation requires the authenticated user has an Administrator role on the Capsule account.

POST
https://api.capsulecrm.com/api/v2/titles
          {
  "personTitle" : {
    "title" : "madam"
  }
}
        

Response

Returns HTTP status code 201. The body of the response will contain the title as it was stored in Capsule.

HTTP/1.1 201
{
  "personTitle" : {
    "id" : 8,
    "title" : "madam"
  }
}

Delete custom title

Delete a custom title from Capsule. Titles can only be deleted if they are not in use by any party. This operation requires the authenticated user has an Administrator role on the Capsule account.

DELETE
https://api.capsulecrm.com/api/v2/titles/{titleId}

Response

Returns HTTP status code 204. The response will contain an empty body.

HTTP/1.1 204