Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Lists

Edit a list

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

put/api/v2/lists/{id}

Path parameters

idinteger required

Request body

namestring required

List name.

sharedboolean

Make this list shared or not?

favoritedboolean

Is list favorited.

isDefaultboolean

Is list default for new contacts (web only).

Example request

{
  "name": "Private list",
  "shared": true,
  "favorited": true,
  "isDefault": true
}

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"
}