Criação de agente via API

Endpoint público para criar uma ou várias combinações de agentes RCS em uma única requisição. Os campos de parceiro e os documentos CNPJ são opcionais; os demais campos documentados abaixo são obrigatórios.

Endpointhttps://rcs.yup.chat/rcs/create Autenticaçãox-api-key: SUA_CHAVE_AQUI Formatoapplication/json; charset=utf-8

Exemplo de cURL

Envie o JSON completo no corpo da requisição. O endpoint cria uma combinação para cada item de agentTypes x categories. 

curl -X POST "https://rcs.yup.chat/rcs/create" \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_CHAVE_AQUI" \
  --data-binary @payload.json

Payload JSON completo

Campos de marca, parceiro opcional e URL opcional do cartão CNPJ são aceitos diretamente pelo endpoint público.

{
  "agentDisplayName": "Minha Marca",
  "description": "Atendimento oficial via RCS.",
  "interactionsDescription": "Promoções, suporte, notificações e atualizações da marca.",
  "logoUri": "https://cdn.marca.com/rcs/logo.jpg",
  "heroUri": "https://cdn.marca.com/rcs/banner.jpg",
  "previewUri": "https://cdn.marca.com/rcs/preview.png",
  "color": "#6D3EE8",
  "phone": "+55 (11) 99999-9999",
  "email": "contato@marca.com.br",
  "website": "https://marca.com.br",
  "privacy": {
    "uri": "https://marca.com.br/privacidade",
    "label": "Política de Privacidade"
  },
  "terms": {
    "uri": "https://marca.com.br/termos",
    "label": "Termos de Serviço"
  },
  "cnpj": "00.000.000/0000-00",
  "cnpjCardUrl": "https://cdn.marca.com/documentos/cartao-cnpj.pdf",
  "brandContactName": "Nome do contato da marca",
  "brandContactEmailAddress": "contato@marca.com.br",
  "brandWebsiteUrl": "https://marca.com.br",
  "brandPartnerCompanyName": "Empresa parceira",
  "brandPartnerContactName": "Nome do contato parceiro",
  "brandPartnerContactEmailAddress": "parceiro@empresa.com.br",
  "agentTypes": ["NON_CONVERSATIONAL", "CONVERSATIONAL"],
  "categories": ["TRANSACTIONAL", "PROMOTIONAL", "OTP"]
}

Resposta esperada

{
  "ok": true,
  "count": 6,
  "plannedCount": 6,
  "agentIds": ["agent-1", "agent-2", "agent-3", "agent-4", "agent-5", "agent-6"],
  "agentUseCase": ["TRANSACTIONAL", "PROMOTIONAL", "OTP"],
  "failures": [],
  "emailAttachments": ["cartao-cnpj.pdf"],
  "authorizationEmail": {
    "sent": true,
    "to": ["contato@marca.com.br"]
  }
}

Referência completa de campos

Todos os campos aceitos pelo endpoint de criação.
Campo Tipo Obrigatório Descrição Exemplo
agentDisplayName string Sim Nome base do agente. O sistema cria variações por tipo e caso de uso. "Minha Marca"
description string Sim Descrição curta exibida no perfil do agente. "Atendimento oficial via RCS."
interactionsDescription string Sim Descrição enviada ao questionário de lançamento. "Suporte e notificações."
logoUri URL HTTPS Sim Logotipo público do agente. A URL precisa ser HTTPS, retornar HTTP 200 e servir PNG ou JPEG. Recomendado 224x224, até 50 KB. "https://.../logo.jpg"
heroUri URL HTTPS Sim Banner público do agente. A URL precisa ser HTTPS, retornar HTTP 200 e servir PNG ou JPEG. Recomendado 1440x448, até 200 KB. "https://.../banner.jpg"
previewUri URL HTTPS Sim Imagem do preview final usada no questionário. A URL precisa ser HTTPS, retornar HTTP 200 e servir PNG ou JPEG. "https://.../preview.png"
color HEX Sim Cor de destaque do agente. Aceita #RGB ou #RRGGBB. "#6D3EE8"
phone string Sim Telefone exibido no perfil. "+55 (11) 99999-9999"
email email Sim E-mail público do agente. "contato@marca.com.br"
website URL HTTPS Sim Site oficial. Também é usado no questionário de lançamento. "https://marca.com.br"
privacy.uri URL HTTPS Sim Política de privacidade. "https://marca.com.br/privacidade"
privacy.label string Sim Rótulo exibido para a política de privacidade. "Política de Privacidade"
terms.uri URL HTTPS Sim Termos de serviço. "https://marca.com.br/termos"
terms.label string Sim Rótulo exibido para os termos. "Termos de Serviço"
cnpj string Não CNPJ da marca/empresa. "00.000.000/0000-00"
cnpjCardUrl URL HTTPS Não URL pública do PDF do cartão/documento CNPJ. Se enviada, será anexada ao e-mail interno. "https://.../cartao-cnpj.pdf"
brandContactName string Sim Nome do contato dono da marca. "Maria Silva"
brandContactEmailAddress email Sim E-mail do dono da marca para aprovação/autorização. "maria@marca.com.br"
brandWebsiteUrl URL HTTPS Sim Site da marca para contato de verificação. "https://marca.com.br"
brandPartnerCompanyName string Não Empresa parceira da marca. Se um campo de parceiro for enviado, informe também os demais campos do parceiro. "Agência XYZ"
brandPartnerContactName string Não Contato da empresa parceira. Obrigatório apenas quando houver parceiro informado. "João Souza"
brandPartnerContactEmailAddress email Não E-mail que recebe o pedido de autorização quando houver parceiro informado. "joao@agencia.com.br"
agentTypes array Sim Tipos de agente. Aceita NON_CONVERSATIONAL e CONVERSATIONAL. ["NON_CONVERSATIONAL"]
categories array Sim Casos de uso. Aceita TRANSACTIONAL, PROMOTIONAL e OTP. ["TRANSACTIONAL", "PROMOTIONAL", "OTP"]