vértice
Produto Preços Painel
Status

Publicar status de texto

Publica um status de texto para os contatos informados ou para os contatos locais.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/status/text" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"text":"Novo status","backgroundColor":"#111111"}'
POST /instances/{id}/status/text
API key
Entenda

Conceituação

Publica um status de texto para os contatos informados ou para os contatos locais.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

Body

text string opcional

Corpo da mensagem. Respeite o limite de 65.536 caracteres.

backgroundColor string opcional

Campo backgroundColor do corpo JSON.

Payload

Request Body

{
  "text": "Novo status",
  "backgroundColor": "#111111"
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.