Skip to content

Deactivate flows by platform

Request

Desactiva los flows activos del customer para una plataforma. Si el customer tiene más de una integración para esa plataforma, chat_id es obligatorio para identificar la conversación a desactivar; con una sola integración se resuelve automáticamente.

Security
api-key
Bodyapplication/jsonrequired
customer_idstring

ID del customer (web_id). Requerido si no se proporciona customer_phone

Example:"d126hhh"
customer_phonestring

Teléfono del customer (formato internacional con +). Requerido si no se proporciona customer_id

Example:"+573201548587"
platformstringrequired

Plataforma sobre la cual se realizará la búsqueda para desactivar flows específicos para el customer. Valores permitidos: 'whatsapp', 'messenger' o 'instagram'

Enum:"whatsapp""messenger""instagram"
Example:"whatsapp"
chat_idstring

ID de la conversación en el inbox. Obligatorio cuando el customer tiene más de una integración para la plataforma.

Example:"6ab18f514477dd0bcd313ab5"
curl -i -X POST \
  https://app.mercately.com/retailers/api/v1/flow_deactivation \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "customer_id": "d126hhh",
    "customer_phone": "+573201548587",
    "platform": "whatsapp",
    "chat_id": "6ab18f514477dd0bcd313ab5"
  }'

Responses

OK

Bodyapplication/json
messagestring
Example:"Flows by platform successfully deactivated"
infoobject
Example:
{ "data": {} }
Response
{ "message": "Flows by platform successfully deactivated", "info": { "data": {} } }