USusesend

GET /v1/contactBooks/{contactBookId}

Changed on

Request

Path parameters

contactBookIdstring required
Example:clx1234567890

Response

Retrieve the contact book

idstring required

The ID of the contact book

namestring required

The name of the contact book

teamIdnumber required

The ID of the team

propertiesobject required

Custom properties for the contact book

variablesstring[] required

Allowed personalization variables for contacts in this book

emojistring required

The emoji associated with the contact book

doubleOptInEnabledboolean

Whether double opt-in is enabled for new contacts

doubleOptInFromstring nullable

From address used for double opt-in emails (must use a verified domain)

doubleOptInSubjectstring nullable

Subject line used for double opt-in confirmation email

doubleOptInContentstring nullable

Email editor JSON content used for double opt-in confirmation

createdAtstring required

The creation timestamp

updatedAtstring required

The last update timestamp

Example response

{
  "id": "clx1234567890",
  "name": "Newsletter Subscribers",
  "teamId": 1,
  "properties": {
    "customField1": "value1"
  },
  "variables": [
    "registrationCode",
    "company"
  ],
  "emoji": "📙",
  "doubleOptInEnabled": true,
  "doubleOptInFrom": "Newsletter <hello@example.com>",
  "doubleOptInSubject": "Please confirm your subscription"
}

Changes

  • ee7832fe66a6Revision changes
    • info

      the response property / became required for the status

    • info

      added the required property to the response with the status

  • 1bc45cd7b94eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status