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}

Request

Base URL
https://rest.textmagic.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/textmagic/apis/textmagic-api/docs/api/v2/lists/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

namestring required

List name.

sharedboolean

Make this list shared or not?

favoritedboolean

Is list favorited.

isDefaultboolean

Is list default for new contacts (web only).

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

Returned when successful.

idinteger required

Resource ID.

hrefstring required

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

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

No recorded changes to this operation across all 4 revisions of this API.