Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Lists

Create a new list

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Lists/createList" target="_blank">Try in sandbox</a><br>

post/api/v2/lists

Request body

namestring required

List name.

sharedboolean

Should the new list be shared among all the sub-accounts?

favoritedboolean

Is the list favorited? Default is false.

isDefaultboolean

Is the list default for new contacts (web only)?

Example request

{
  "name": "Private list"
}

Response

Returned when successful.

idinteger required

Resource ID.

hrefstring required

A link to this resource. If you want to fetch it, just GET this address.

Example response

{
  "id": 515,
  "href": "/api/v2/entity_name/1"
}