Chatarmin

List Contacts

Retrieve a paginated list of Chatarmin contacts with optional text search.

Get Contact

Retrieve one Chatarmin contact by contact ID or externalId.

Create Contact

Create a new Chatarmin contact.

Update Contact

Update an existing Chatarmin contact by contact ID or externalId.

Delete Contact

Delete a Chatarmin contact by contact ID or externalId.

Send Message

Send a WhatsApp text, media, document, or template message to a Chatarmin contact.

List Campaigns

Retrieve a paginated list of Chatarmin campaigns with optional day or month metrics.

Get Campaign

Retrieve one Chatarmin campaign by campaign ID.

List Flows

Retrieve a paginated list of Chatarmin flows with optional day or month metrics.

Get Flow

Retrieve one Chatarmin flow by flow ID.

Get Flow Analytics

Retrieve paginated Chatarmin flow analytics for a flow.

Get Flow Contact Analytics

Retrieve Chatarmin flow analytics for specific contacts.

List Voucher Pools

Retrieve a paginated list of Chatarmin voucher pools with voucher codes.

Get Voucher Pool

Retrieve one Chatarmin voucher pool by voucher pool ID.

Create Voucher Pool

Create a Chatarmin voucher pool with an initial list of voucher codes.

Update Voucher Pool

Update a Chatarmin voucher pool's name, settings, or unused voucher codes.

Add Or Replace Voucher Codes

Add new voucher codes to a Chatarmin pool or replace one unused code.

Remove Voucher Code

Remove one unused voucher code from a Chatarmin voucher pool.

Delete Voucher Pool

Delete a Chatarmin voucher pool and its unused voucher codes.

List Webhooks

Retrieve all Chatarmin webhooks for the authenticated user.

Create Webhook

Create a Chatarmin webhook for one supported topic.

Update Webhook

Update a Chatarmin webhook URL or topic.

Delete Webhook

Delete a Chatarmin webhook by webhook ID.