Skip to main content
POST
Create a Person

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Body

application/json

Request body for creating a Person.

firstName
string
required

The person's first name.

Example:

"Jane"

lastName
string | null
required

The person's last name.

Example:

"Doe"

primaryEmailAddress
string<email> | null
required

The person's primary email address.

Example:

"jane.doe@northpointvc.com"

emailAddresses
string<email>[]

All of the person's email addresses. If not provided, defaults to [{primaryEmailAddress}]

Maximum array length: 100
Example:
fields
fields.FieldUpdate · object[]

Field-value updates to apply to the newly created Person.

Maximum array length: 100

Response

Created

Person model

id
integer<int64>
required

The persons's unique identifier

Required range: 1 <= x <= 9007199254740991
Example:

1

firstName
string
required

The person's first name

Example:

"Jane"

lastName
string | null
required

The person's last name

Example:

"Doe"

primaryEmailAddress
string<email> | null
required

The person's primary email address

Example:

"jane.smith@northpointvc.com"

emailAddresses
string<email>[]
required

All of the person's email addresses

Example:
type
enum<string>
required

The person's type. internal - people who are users within your Affinity instance. external - people who are not internal.

Available options:
internal,
external
Example:

"internal"

fields
Field · object[]

The fields associated with the person