AFaffinity
Lists

Create a List

Changed on
⚠️ This endpoint is currently in BETA

Create a new List.

The List type determines the kind of entities (Companies, Persons, or Opportunities) that can be added. The requester is recorded as the creator and the owner.

post/v2/lists

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/lists
  • Auth
    HTTP bearer

Request body

namestring required

The name of the List

type'company' | 'opportunity' | 'person' required

The entity type for the List

isPublicboolean

Whether the List is public. Public Lists are visible to all users in the organization. Creating a public List requires the "Share accessible Lists globally" permission.

Example request

{
  "name": "My Companies",
  "type": "company"
}

Response

Created

idinteger required

The unique identifier for the list

namestring required

The name of the list

creatorIdinteger required

The ID of the user that created this list

ownerIdinteger required

The ID of the user that owns this list

isPublicboolean required

Whether or not the list is public

type'company' | 'opportunity' | 'person' required

The entity type for this list

createdAtstring date-time required

The date and time the list was created

Example response

{
  "id": 1,
  "name": "All companies",
  "creatorId": 1,
  "ownerId": 1,
  "type": "company",
  "createdAt": "2024-03-07T20:21:42Z"
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status