Represents a contact that is stored in Capsule. This can be either a person or an organisation.
Name | Type | Description | |
---|---|---|---|
id | Long | Read only |
The unique id of this party. |
type | String | Required |
Represents if this party is a person or an organisation. Accepted values are: |
firstName | String |
The first name of the person. This field is present only when |
|
lastName | String |
The last name of the person. This field is present only when |
|
title | String |
The title of the person. This field is present only when Accepted values are: |
|
jobTitle | String |
The job title of the person. This field is present only when |
|
organisation | Nested Party |
The organisation this party is associated with. This field is present only when |
|
name | String |
The name of the organisation. This field is present only when |
|
about | String |
A short description of the party. |
|
createdAt | Date | Read only |
The ISO date/time when this party was created. |
updatedAt | Date | Read only |
The ISO date/time when this party was last updated. |
lastContactedAt | Date | Read only |
The ISO date/time when this party was last contacted. |
addresses | Array of Address |
An array of all the addresses associated with this party. |
|
phoneNumbers | Array of Phone Number |
An array of all the phone numbers associated with this party. |
|
websites | Array of Website |
An array of the websites and social network accounts associated with this party. |
|
emailAddresses | Array of Email Address |
An array of all the email addresses associated with this party. |
|
pictureURL | String | Read only |
A URL that represents the location of the profile picture for this party. This field is automatically derived by Capsule. |
tags | Array of Nested Tag |
An array of tags that are added to this party. This field is included in responses only if the
|
|
fields | Array of Field Value |
An array of custom fields that are defined for this party. This field is included in responses
only if the |
|
owner | Nested User |
The user this party is assigned to. |
|
team | Nested Team |
The team this party is assigned to. |
|
missingImportantFields | Boolean |
Indicates if this party has any Important custom fields that are missing a value. This field is included in responses only if the |