Skip to content
LeadPattern
Reference/Contacts

Contacts API

LeadPattern Contacts API: 9 endpoints with request parameters, response schemas, error codes and cURL, Node.js and Python examples.

GETList Contacts/customer/list?page=1&limit=20Retrieve a paginated list of contacts, with optional search and smart filters.POSTCreate Contact/customerCreate or upsert a contact by phone number.GETGet Contact/customer/:waIdRetrieve a single contact by WhatsApp ID (waId).PUTSet Custom Attribute/customer/:waIdSet or update one custom attribute on a contact, addressed by its slug. The value must match the attribute's configured type (string, number or date).POSTDelete Contacts/customer/deletePermanently delete one or more contacts and their message history.PATCHAdd / Remove Contact Tag/customer/:waId/tagsAdd or remove a single tag on a contact.PATCHClose / Reopen Chat/customer/:waId/statusChange a conversation's status to "closed" or "open".PATCHArchive / Unarchive Chat/customer/:waId/archiveArchive or unarchive a chat. Independent of open/closed status — an archived chat is hidden from the default inbox view until unarchived.PATCHUpdate Opt-Out Status/customer/:waId/opt-outOpt a contact in or out of messaging.