Criar contato

Cria novo contato

POSThttps://api-publica.sunchat.com.br/v1/contatodechat

curl --request POST \
  --url 'https://api-publica.sunchat.com.br/v1/contatodechat' \
  --header 'X-Ambiente: SEU_NUMERO_DE_CONTA' \
  --header 'X-Authorization: X-Chave-Api SUA_CHAVE' \
  --header 'Content-Type: application/json' \
  --data '{}'

Autenticação

X-Ambientestring (header)obrigatório

Número da sua conta no SunchatPlus. Aceita também `X-Canal` com o ID de um canal, que resolve a conta a partir dele.

X-Authorizationstring (header)obrigatório

Chave de API no formato `X-Chave-Api {chave}`. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.

Corpo da requisição

Telefonestringobrigatório

TipoDeContatoenum<integer>

Valores aceitos: - `0` — TelefonePrincipal - `1` — Whatsapp - `2` — Instagram - `3` — Facebook - `4` — Telegram - `5` — WebChat

Valores: 0, 1, 2, 3, 4, 5

Nomestring | null

NomeNaAgendastring | null

Apelidostring | null

Emailstring<email> | null

Observacaostring | null

EhGrupoboolean

Principalboolean

ProfilePicUrlstring | null

IdPessoastring<uuid> | null

IdCanalstring<uuid> | null

IdUsuarioFidelizadostring<uuid> | null

IdDepartamentoTransbordostring<uuid> | null

EnviarParaGrupoDeChatCasoUsuarioOfflineboolean

Resposta 201

Created

Idstring<uuid>

TipoDeContatoenum<integer>

Valores aceitos: - `0` — TelefonePrincipal - `1` — Whatsapp - `2` — Instagram - `3` — Facebook - `4` — Telegram - `5` — WebChat

Valores: 0, 1, 2, 3, 4, 5

Nomestring | null

NomeNaAgendastring | null

Apelidostring | null

Telefonestring | null

Emailstring | null

Observacaostring | null

EhGrupoboolean

Principalboolean

ProfilePicUrlstring | null

IdPessoastring<uuid> | null

IdCanalstring<uuid> | null

IdUsuarioFidelizadostring<uuid> | null

IdDepartamentoTransbordostring<uuid> | null

EnviarParaGrupoDeChatCasoUsuarioOfflineboolean

DataDaCriacaostring<date-time>

DataDaAlteracaostring<date-time>

Resposta 409

Conflict

typestring | null

titlestring | null

statusinteger<int32> | null

detailstring | null

instancestring | null

Resposta 422

Unprocessable Content

typestring | null

titlestring | null

statusinteger<int32> | null

detailstring | null

instancestring | null

errorsobject | null