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"
}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": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}| 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 |
get/callPurposes
Request samples
- curl
- JavaScript
- Python
- Go
- Java
Response samples
- 200
- 422
application/vnd.api+json
{- "data": [
- {
- "attributes": {
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "order": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "id": 0,
- "relationships": {
- "calls": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}, - "type": "string"
}
]
}Create a New Call Purpose
SecuritybearerAuth
Request
Request Body schema: application/vnd.api+jsonrequired
object |
Responses
201
Created
422
JSON error message
post/callPurposes
Request samples
- Payload
- curl
- JavaScript
- Python
- Go
- Java
application/vnd.api+json
{- "data": {
- "attributes": {
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "order": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "relationships": {
- "calls": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}, - "type": "string"
}
}Response samples
- 201
- 422
application/vnd.api+json
{- "data": {
- "attributes": {
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "order": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "id": 0,
- "relationships": {
- "calls": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}, - "type": "string"
}
}get/callPurposes/{id}
Request samples
- curl
- JavaScript
- Python
- Go
- Java
Response samples
- 200
- 404
application/vnd.api+json
{- "data": {
- "attributes": {
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "order": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "id": 0,
- "relationships": {
- "calls": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}, - "type": "string"
}
}patch/callPurposes/{id}
Request samples
- Payload
- curl
- JavaScript
- Python
- Go
- Java
application/vnd.api+json
{- "data": {
- "attributes": {
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "order": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "id": 0,
- "relationships": {
- "calls": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}, - "type": "string"
}
}Response samples
- 200
- 422
application/vnd.api+json
{- "data": {
- "attributes": {
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "order": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "id": 0,
- "relationships": {
- "calls": [
- {
- "links": {
- "related": "call"
}
}
], - "creator": {
- "data": {
- "id": 0,
- "type": "user"
}
}
}, - "type": "string"
}
}