contacts

Update Contact List

Changed on

Update mutable fields of a contact list.

Requires the contact_lists:write scope on the API key.

patch/v1/contact-lists/{contact_list_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contact-lists/{contact_list_id}
  • Auth: HTTP bearer

Path parameters

contact_list_idstring uuid required

ID of the contact list.

Request body

namestring nullable

New name for the list.

default_sequence_template_idstring uuid nullable

New default sequence template. Pass null to clear.

Response

Successful Response

idstring uuid required

Unique identifier.

namestring nullable required

Name of the list.

default_sequence_template_idstring uuid nullable required

Default sequence template for new entries.

entries_countinteger required

Current number of entries in the list.

created_atstring date-time required

When the list was created.

updated_atstring date-time required

When the list last changed.

Changes