Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Contact Lists

POST (create) a List

Create a new contact list resource

post/contact_lists

Request body

namestring required

The name given to the contact list

favoriteboolean

Identifies whether or not the account has favorited the contact list.

descriptionstring

Text describing the list.

Example request

{
  "name": "Multiple purchases",
  "favorite": true,
  "description": "List of repeat customers"
}

Response

New list successfully created

list_idstring uuid required

Unique ID for the contact list

namestring required

The name given to the contact list

descriptionstring

Text describing the list.

favoriteboolean

Identifies whether or not the account has favorited the contact list.

created_atstring date-time

System generated date and time that the resource was created, in ISO-8601 format.

updated_atstring date-time

Date and time that the list was last updated, in ISO-8601 format. System generated.

deleted_atstring date-time

If the list was deleted, this property shows the date and time it was deleted, in ISO-8601 format. System generated.

Example response

{
  "list_id": "06526938-56dd-11e9-932a-fa163ea075fa",
  "name": "Multiple purchases",
  "description": "List of repeat customers.",
  "created_at": "2016-01-23T13:48:44.108Z",
  "updated_at": "2016-03-03T10:56:29-05:00",
  "deleted_at": "2016-03-03T10:56:29-05:00"
}