v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Contact Lists

Move contacts to a contact list

<small>Requires the contacts:operate scope (or a broader one that includes it).</small>

Moves contacts to the specified contact list. This is a non-atomic operation: successfully moved contacts are not rolled back if some fail. The response contains only the failed items with their error details.

post/v3/contact-lists/{id}/move-contacts

Path parameters

idinteger required

Contact list ID

Request body

contactIdsinteger[] required

Array of contact IDs to move

Response

Move operation completed. Response is a dictionary keyed by contact ID. Only failed items appear; missing IDs were moved successfully.

Possible per-item error codes:

errorMeaning
8ContactNotProcessed — contact could not be moved (e.g. access denied, invalid ID)
object required