Call Purpose

A ready-made collection of call purposes that help categorize your call logs.

createdAt
string <date-time>

The date and time the call purpose was created.

name
string <= 255 characters

The purpose’s name (e.g. "Initial Contact").

order
integer

The purpose’s display order within the collection.

updatedAt
string <date-time>

The date and time the call purpose was last updated.

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Call Purpose Relationships

Array of links (object) (call)

The calls made with this purpose. Relationship calls cannot be used as a filter.

(user (data (object) or links (object)))

The creator of the call purpose. Relationship creator cannot be used as a filter.

{
  • "calls": [
    ],
  • "creator": {
    }
}

Call Purpose Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Call Purpose Actions

Get a Collection of Call Purposes

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/callPurposes
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Call Purpose
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/callPurposes
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Call Purpose by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/callPurposes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Call Purpose by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/callPurposes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Call Purpose
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/callPurposes/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}