Recipient

Record for a recipient for some communication, such as email

createdAt
string <date-time>

The date and time the team was created.

emailHash
string <= 255 characters

Hash of email for recipient.

primary
boolean

True when the recipient is the primary recipient.

recipientType
string <= 3 characters

The type of action for the communcation to the recipient. Must be one of 'bcc', 'cc', or 'to'.

updatedAt
string <date-time>

The date and time the team was last updated.

value
string <= 255 characters

The recipient contact information (i.e. email address)

{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "emailHash": "string",
  • "primary": true,
  • "recipientType": "str",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Recipient Relationships

data (object) or links (object) (prospect)

The prospect entity relation.

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

The user entity relation.

{
  • "prospect": {
    },
  • "user": {
    }
}

Recipient 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

⌵ Recipient Actions

Get a Collection of Recipients

SecuritybearerAuth
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


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


404
Not Found


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


422
JSON error message


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