Chatarmin

Chatarmin integration (Marketing, Communication). Imported from open-connector.

API key23 toolshttps://api.chatarmin.com/api/public

GET

chatarmin_list_contacts

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

/contacts

3 parameters

Param	Type	Required	Description
page	integer	optional	The page number for pagination.
limit	integer	optional	The number of items to return per page.
search	string	optional	Optional search text matched by Chatarmin against firstname, lastname, email, a…

GET

chatarmin_get_contact

Retrieve one Chatarmin contact by contact ID or externalId.

/contacts/{contactId}

1 parameter

Param	Type	Required	Description
contactId	string	required	The Chatarmin contact ID or externalId.

PUT

chatarmin_create_contact

Create a new Chatarmin contact.

/contacts

7 parameters

Param	Type	Required	Description
phone	string	required	The contact phone number in international format.
email	string	optional	The contact email address.
firstname	string	required	The contact first name.
lastname	string	optional	The contact last name.
consent	string	required	The Chatarmin consent state for the contact.
externalId	string	optional	An external identifier to store on the contact.
properties	object	optional	Custom contact properties keyed by Chatarmin property name.

POST

chatarmin_update_contact

Update an existing Chatarmin contact by contact ID or externalId.

/contacts/{contactId}

8 parameters

Param	Type	Required	Description
contactId	string	required	The Chatarmin contact ID or externalId.
phone	string	optional	The contact phone number in international format.
email	string	optional	The contact email address.
firstname	string	optional	The contact first name.
lastname	string	optional	The contact last name.
consent	string	optional	The Chatarmin consent state for the contact.
externalId	string	optional	An external identifier to store on the contact.
properties	object	optional	Custom contact properties keyed by Chatarmin property name.

DELETE

chatarmin_delete_contact

Delete a Chatarmin contact by contact ID or externalId.

/contacts/{contactId}

1 parameter

Param	Type	Required	Description
contactId	string	required	The Chatarmin contact ID or externalId.

POST

chatarmin_send_message

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

/messages/send

11 parameters

Param	Type	Required	Description
phone	string	optional	The recipient phone number in international format.
email	string	optional	The recipient email address used to look up the contact.
contactId	string	optional	The Chatarmin contact ID or externalId of the recipient.
type	string	required	The WhatsApp message type to send.
text	string	optional	The message body text. Required when type is text.
mediaUrl	string	optional	The publicly accessible media URL. Required for image, video, and document mess…
caption	string	optional	An optional media caption. Chatarmin supports captions up to 1024 characters.
fileName	string	optional	An optional file name for document messages.
templateName	string	optional	The exact approved WhatsApp template name.
language	string	optional	The WhatsApp template language code approved for the template.
components	array	optional	Template components used to fill dynamic template placeholders.

GET

chatarmin_list_campaigns

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

/campaigns

5 parameters

Param	Type	Required	Description
page	integer	optional	The page number for pagination.
limit	integer	optional	The number of items to return per page.
groupBy	string	optional	The analytics grouping period.
startDate	string	optional	The start date for grouped campaign metrics.
endDate	string	optional	The end date for grouped campaign metrics.

GET

chatarmin_get_campaign

Retrieve one Chatarmin campaign by campaign ID.

/campaigns/{campaignId}

1 parameter

Param	Type	Required	Description
campaignId	string	required	The Chatarmin campaign ID.

GET

chatarmin_list_flows

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

/flows

5 parameters

Param	Type	Required	Description
page	integer	optional	The page number for pagination.
limit	integer	optional	The number of items to return per page.
groupBy	string	optional	The analytics grouping period.
startDate	string	optional	The start date for grouped flow metrics.
endDate	string	optional	The end date for grouped flow metrics.

GET

chatarmin_get_flow

Retrieve one Chatarmin flow by flow ID.

/flows/{flowId}

1 parameter

Param	Type	Required	Description
flowId	string	required	The Chatarmin flow ID.

GET

chatarmin_get_flow_analytics

Retrieve paginated Chatarmin flow analytics for a flow.

/flows/analytics/{flowId}

5 parameters

Param	Type	Required	Description
flowId	string	required	The Chatarmin flow ID.
page	integer	optional	The page number for pagination.
limit	integer	optional	The number of items to return per page.
start	string	optional	The analytics start timestamp in ISO 8601 format.
end	string	optional	The analytics end timestamp in ISO 8601 format.

POST

chatarmin_get_flow_contact_analytics

Retrieve Chatarmin flow analytics for specific contacts.

/flows/analyticsv2/{flowId}

4 parameters

Param	Type	Required	Description
flowId	string	required	The Chatarmin flow ID.
contactIds	array	required	Contact IDs to fetch analytics for.
start	string	optional	The analytics start timestamp in ISO 8601 format.
end	string	optional	The analytics end timestamp in ISO 8601 format.

GET

chatarmin_list_voucher_pools

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

/voucher-pools

2 parameters

Param	Type	Required	Description
page	integer	optional	The page number for pagination.
limit	integer	optional	The number of items to return per page.

GET

chatarmin_get_voucher_pool

Retrieve one Chatarmin voucher pool by voucher pool ID.

/voucher-pools/{poolId}

1 parameter

Param	Type	Required	Description
poolId	string	required	The Chatarmin voucher pool ID.

POST

chatarmin_create_voucher_pool

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

/voucher-pools

5 parameters

Param	Type	Required	Description
poolName	string	required	The display name of the voucher pool.
vouchers	array	required	Voucher code strings to add to the pool.
reuseCodes	boolean	optional	Whether contacts who already received a code should get the same code again.
reminder	object	optional	Low-voucher email reminder settings.
emptyOptions	object	optional	Behavior settings for an empty voucher pool.

PUT

chatarmin_update_voucher_pool

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

/voucher-pools/{poolId}

6 parameters

Param	Type	Required	Description
poolId	string	required	The Chatarmin voucher pool ID.
poolName	string	optional	The display name of the voucher pool.
vouchers	array	optional	Voucher code strings to add to the pool.
reuseCodes	boolean	optional	Whether contacts who already received a code should get the same code again.
reminder	object	optional	Low-voucher email reminder settings.
emptyOptions	object	optional	Behavior settings for an empty voucher pool.

POST

chatarmin_add_or_replace_voucher_codes

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

/voucher-pools/{poolId}/vouchers

3 parameters

Param	Type	Required	Description
poolId	string	required	The Chatarmin voucher pool ID.
codes	array	optional	Voucher code strings to add to the pool.
replaceCode	object	optional	An unused voucher code replacement.

DELETE

chatarmin_remove_voucher_code

Remove one unused voucher code from a Chatarmin voucher pool.

/voucher-pools/{poolId}/vouchers/{code}

2 parameters

Param	Type	Required	Description
poolId	string	required	The Chatarmin voucher pool ID.
code	string	required	The voucher code string to remove.

DELETE

chatarmin_delete_voucher_pool

Delete a Chatarmin voucher pool and its unused voucher codes.

/voucher-pools/{poolId}

1 parameter

Param	Type	Required	Description
poolId	string	required	The Chatarmin voucher pool ID.

GET

chatarmin_list_webhooks

Retrieve all Chatarmin webhooks for the authenticated user.

/webhooks

PUT

chatarmin_create_webhook

Create a Chatarmin webhook for one supported topic.

/webhooks

2 parameters

Param	Type	Required	Description
url	string	optional	The webhook target URL.
topic	string	optional	The Chatarmin webhook topic.

POST

chatarmin_update_webhook

Update a Chatarmin webhook URL or topic.

/webhooks/{webhookId}

3 parameters

Param	Type	Required	Description
webhookId	string	required	The Chatarmin webhook ID.
url	string	optional	The webhook target URL.
topic	string	optional	The Chatarmin webhook topic.

DELETE

chatarmin_delete_webhook

Delete a Chatarmin webhook by webhook ID.

/webhooks/{webhookId}

1 parameter

Param	Type	Required	Description
webhookId	string	required	The Chatarmin webhook ID.