Persona

A descriptor of a person, used for categorizing Prospects.

createdAt
string <date-time>

The date and time the persona was created.

description
string <= 255 characters

A description of the persona.

name
string <= 255 characters

The name of the persona (e.g. "Sales Rep").

updatedAt
string <date-time>

The date and time the persona was last updated.

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

Persona Relationships

Array of links (object) (prospect)

The prospects with this persona. Relationship prospects cannot be used as a filter.

{
  • "prospects": [
    ]
}

Persona 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

⌵ Persona Actions

Get a Collection of Personas

SecuritybearerAuth
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


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


404
Not Found


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


422
JSON error message


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