Skip to main content
POST
Add a List Entry to a List

Authorizations

Authorization
string
header
required

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

Path Parameters

listId
integer<int64>
required

List ID

Required range: 1 <= x <= 9007199254740991

Body

application/json

Request body for creating a List Entry on a List. The entity referenced by entity.id must match the List's type: a Company ID for a company List, a Person ID for a person List. Opportunities cannot be added with this endpoint. An opportunity List's entries are the opportunities themselves, and each opportunity belongs to exactly one List, so an existing entity cannot be added to one.

entity
object
required

The Company or Person to add to the List. Provide its id; the entity must exist and match the List's type (a Company ID for a company List, a Person ID for a person List).

creatorId
integer<int64>

The internal Person ID to record as the List Entry's creator. Defaults to the authenticated user. Must be an internal Person in the same organization as the caller.

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

67890

Response

Created

id
integer<int64>
required

The list entry's unique identifier

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

1

type
string
required

The entity type for this list entry

Allowed value: "company"
Example:

"company"

listId
integer<int64>
required

The ID of the list that this list entry belongs to

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

1

createdAt
string<date-time>
required

The date that the list entry was created

Example:

"2023-01-01T00:00:00Z"

creatorId
integer<int64> | null
required

The ID of the user that created this list entry

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

1

entity
Company · object
required

Company model