Opt-out

Consultar opt-out

Diz se o telefone está em opt-out. Telefone fora do E.164 responde 400 INVALID_PHONE. Permissão: ADMIN.

get/v1/opt-outs/{phone}

Request

Base URL
https://api.ararahq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/opt-outs/:phone/get.ts
A function with typed inputs. Its response is checked against the schema.

phonestring required

Telefone E.164 com + (ex. +5511999999999).

Situação

phonestring required

channelstring required

optedOutboolean required

{
  "channel": "WHATSAPP"
}