Party Model

Represents an 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: person, organisation

firstName String

First name of the person. This field is present only when type is person

lastName String

Last name of the person. This field is present only when type is person

title String

Title of the person. This field is present only when type is person

Accepted values are: Mr, Master, Mrs, Miss, Ms, Dr, Prof

jobTitle String

Job title of the person. This field is present only when type is person

organisation Nested Party

The organization this party is associated with. This field is present only when type is person

name String

The name of the organization. This field is present only when type is organisation

about String

A short description about the party

createdAt Date Read only

The ISO DateTime when this party was created. This field is automatically set by Capsule and cannot be edited

updatedAt Date Read only

The ISO DateTime when this party was updated last time. This field is automatically set by Capsule and cannot be edited

lastContactedAt Date Read only

The ISO DateTime when this party was last time contacted. This field is automatically set by Capsule and cannot be edited

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

An url that represents the location of the profile picture for this party. This field is automatically derived by Capsule and cannot be edited.

tags Array of Tag

An array of tags that are added to this party. This field is include in responses only if the embed parameter contains tags

fields Array of Field Value

An array of custom fields that are defined for this party. This field is include in responses only if the embed parameter contains fields