whatsapp

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-whatsapp"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/434c5d81-ce24-486b-89b5-b60c6bdc2596/social-card.svg?v=3e7ae33eec8b" alt="whatsapp" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/whatsapp/flows/{id}/run

Send a published Flow to one contact. WhatsApp consent (marketing) and suppression apply; outside the 24-hour window the flow template is used. Needs an idempotency key

Parameters

idstringpathrequired

Request body

application/json
profileIdstringrequired
purposestring
marketing | transactional = marketing
idempotencyKeystring
{
  "profileId": "string",
  "purpose": "marketing",
  "idempotencyKey": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/whatsapp/flows/{id}/run" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","purpose":"marketing","idempotencyKey":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "id": "string",
  "flowId": "string",
  "profileId": "string",
  "enrollmentId": "string",
  "mode": "interactive",
  "status": "sent",
  "reason": "string",
  "response": {},
  "completedAt": "string",
  "createdAt": "string"
}
Schema
idstringrequired
flowIdstringrequired
profileIdstringrequired
enrollmentIdstringrequired
modestringrequired
interactive | template | none
statusstringrequired
sent | blocked | failed | completed
reasonstringrequired
responseobjectrequired
completedAtstringrequired
createdAtstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/whatsapp/flows/{id}/run

GEThttps://hermeticor.com/v1/whatsapp/flows/{id}/runs

Who was sent the Flow and what they answered

Parameters

profileIdstringquery
limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/whatsapp/flows/{id}/runs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "flowId": "string",
      "profileId": "string",
      "enrollmentId": "string",
      "mode": "interactive",
      "status": "sent",
      "reason": "string",
      "response": {},
      "completedAt": "string",
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1WhatsappFlowsByIdRunResponse[]required
Show child parameters
idstringrequired
flowIdstringrequired
profileIdstringrequired
enrollmentIdstringrequired
modestringrequired
interactive | template | none
statusstringrequired
sent | blocked | failed | completed
reasonstringrequired
responseobjectrequired
completedAtstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/whatsapp/flows/{id}/run

5XX Default Response

Same as 4XX · POST /v1/whatsapp/flows/{id}/run

Updated