Sala de Conversa - Atualização de campos do registro.

Método e URL

PATCH https://api.agilize.app/messenger/chat/room/{_id}

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

Nome	Origem	Obrigatório	Tipo	Descrição
x-api-key	header	Sim	string	Chave da API de integração gerada em seu painel gerencial.
_id	path	Sim	integer	ID of Sala de Conversa to update
content-type	header	Sim	string	application/json

Corpo da requisição

Obrigatório: Sim
Content-Type: application/json

Campos do corpo

Campo	Tipo	Obrigatório	Valores / Exemplo	Descrição
guest	string	Não
users	string	Não
prefUser	string	Não
owner	string	Não
prefUserPendAttr	boolean	Não
histUsers	string	Não
tags	string	Não
conversationDetailTags	string	Não
department	string	Não		Departamento atual da sala
contact	string	Não
tl	string	Não
lastTl	string	Não
currFlow	string	Não
currFlowDtLimit	string (date-time)	Não
user	string	Não		Usuário atual atribuído a sala
lead	string	Não
info	object	Não
lastEvent	string (date-time)	Não
createdAt	string (date-time)	Não
lastFromUser	boolean	Não
lastMsg	string	Não
status	string	Não
currCase	string	Não
triggers	object	Não
chSrc	number	Não		Tipo de canal: 1 - WhatsApp, 2 - Facebook, 3 - Instagram, 4 - SMS
chInfo	object	Não
highlightVars	object	Não
botFlag	number	Não
srcId	string	Não
chId	string	Não		Identificador principal da sala no canal. No WhatsApp pode ser telefone ou BSUID quando chIdType = wa_user_id.
chIdType	string	Não	Aceita: wa_user_id	Preenchido apenas quando chId não é o identificador legado do canal. No WhatsApp, indica sala criada somente por BSUID.
chUserId	string	Não		BSUID do usuário WhatsApp quando informado pela Meta.
chPhone	string	Não		Telefone WhatsApp confirmado quando informado pela Meta. Preserva vínculo em salas BSUID-only.
chUsername	string	Não		Username WhatsApp quando informado pela Meta.
chIdPair	string	Não		Par de identidade de canal ja conciliado automaticamente. No WhatsApp: BSUID\|telefone.
mergeTo	string	Não
mergeAt	string (date-time)	Não
utm	object	Não
utmClick	object	Não
chIsPending	boolean	Não		Ativado se o canal estiver pendente de resposta
dtIsArchived	string (date-time)	Não
dtTransfer	string (date-time)	Não
chIsArchived	boolean	Não		Ativado se o canal já foi concluído
isOutbound	boolean	Não		Define se é uma sala criada para envio ativo,
waCoexTaken	boolean	Não		Indica que a sala foi assumida via Coexistência (WhatsApp app) antes de qualquer usuário entrar
isWaitingUser	boolean	Não
leadUserPendAttr	number	Não
contactUserPendAttr	number	Não
companyUserPendAttr	number	Não
_integration	object	Não
transmissionList	string	Não
idleRulesDisabled	boolean	Não
idleRules	object	Não

Estruturas internas

info

{
  "name": "string",
  "phone": "string",
  "email": "string"
}

utm

{
  "provider": "string",
  "source": "string",
  "medium": "string",
  "clickId": "string",
  "campaignId": "string",
  "campaign": "string",
  "groupId": "string",
  "group": "string",
  "creativeId": "string",
  "creative": "string",
  "content": "string",
  "term": "string",
  "url": "string",
  "ref": "string"
}

utmClick

{
  "fbclid": "string",
  "ctwaClid": "string",
  "gclid": "string",
  "gbraid": "string",
  "wbraid": "string",
  "ttclid": "string"
}

idleRules

[
  {
    "rule": "string",
    "idleNextAt": "string (date-time)",
    "idleStep": "number"
  }
]

Exemplo básico:

{
  "guest": "valor",
  "users": [
    "valor"
  ],
  "prefUser": "valor",
  "owner": "valor",
  "prefUserPendAttr": true,
  "histUsers": [
    "valor"
  ],
  "tags": [
    "valor"
  ],
  "conversationDetailTags": [
    "valor"
  ]
}

Respostas

Status	Descrição	Conteúdo
200	success	application/json
401	not authenticated
404	not found
500	general error

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...

PATCH`/messenger/chat/room/{_id}`