Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/crm.incluir.assunto.php

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
assuntoobjectobrigatórioDados do assunto conforme layout (1)
formatostringobrigatórioFormato do retorno (json)

​
Layout do parâmetro “assunto”

Dados do cliente:
CampoTipoTamanhoOcorrênciaDescrição
assunto.cliente.codigostring30opcionalCódigo do cliente (2)
assunto.cliente.nomestring50obrigatórioNome do cliente (2)
assunto.cliente.tipo_pessoastring1opcionalF/J/E (Física/Jurídica/Estrangeiro)
assunto.cliente.cpf_cnpjstring18opcionalCPF ou CNPJ (2)
assunto.cliente.iestring18opcionalInscrição estadual
assunto.cliente.rgstring10opcionalRG do cliente
assunto.cliente.enderecostring50opcionalEndereço
assunto.cliente.numerostring10opcionalNúmero do endereço
assunto.cliente.complementostring50opcionalComplemento do endereço
assunto.cliente.bairrostring30opcionalBairro
assunto.cliente.cepstring10opcionalCEP
assunto.cliente.cidadestring30opcionalConforme Tabela de Cidades
assunto.cliente.ufstring2opcionalUF do cliente
assunto.cliente.paisstring50opcionalConforme Tabela de Países
assunto.cliente.fonestring40opcionalTelefone
assunto.cliente.emailstring50opcionalE-mail do cliente
assunto.cliente.atualizar_clientestring1opcional”S” ou “N” (padrão “S”) (3)
Pessoas de contato:
CampoTipoOcorrênciaDescrição
assunto.cliente.pessoa_contato[]listopcionalLista de pessoas de contato [0..n]
assunto.cliente.pessoa_contato[].id_pessoaintopcionalID da pessoa de contato (4)
assunto.cliente.pessoa_contato[].nomestring(50)opcionalNome da pessoa (4)
assunto.cliente.pessoa_contato[].telefonestring(30)opcionalTelefone
assunto.cliente.pessoa_contato[].ramalstring(10)opcionalRamal
assunto.cliente.pessoa_contato[].emailstring(50)opcionalE-mail
assunto.cliente.pessoa_contato[].departamentostring(20)opcionalDepartamento
Dados do assunto:
CampoTipoOcorrênciaDescrição
assunto.descricao_assuntostringobrigatórioTítulo ou descrição do assunto
assunto.estagio_assuntostring1obrigatórioCódigo do estágio (5)
Ações do assunto:
CampoTipoTamanhoOcorrênciaDescrição
assunto.acoes[]list-obrigatórioLista de ações do assunto [1..n]
assunto.acoes[].acao.descricao_acaostring-obrigatórioDescrição da ação
assunto.acoes[].acao.tipo_data_acaostring1obrigatórioConforme tabela de tipos
assunto.acoes[].acao.data_acaodate20opcionalFormato dd/mm/yyyy (6)
assunto.acoes[].acao.situacao_acaostring-opcionalPadrão “0” (7)
(1) O parâmetro “assunto” deve ser enviado em formato XML ou JSON
(2) Campos de pesquisa: Código, nome e CPF/CNPJ identificam cliente existente; demais dados carregam-se do cadastro
(3) Clientes não cadastrados são incluídos automaticamente (ignora “atualizar_cliente”)
(4) ID ou nome identificam contatos existentes no cliente
(5) Estágio obtido através da “Lista de estágios de assuntos do CRM”
(6) Data considerada apenas quando tipo_data_acao = “D”
(7) Se situacao_acao não for enviado, assume-se “0” como padrão

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-obrigatórioConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados [0..n]
retorno.erros[].errostring-condicionalDescrição do erro
retorno.registros[]list-condicionalLista de resultados da inclusão
retorno.registros[].registroobject-condicionalRepresentação de um assunto
retorno.registros[].registro.sequenciaint-condicionalNúmero sequencial
retorno.registros[].registro.statusstring-condicional”OK” ou “Erro”
retorno.registros[].registro.codigo_erroint-condicionalCódigo do erro
retorno.registros[].registro.erros[]list-condicionalLista de erros [0..n]
retorno.registros[].registro.erros[].errostring-condicionalDescrição do erro
retorno.registros[].registro.idint-condicionalID do assunto na Olist
retorno.registros[].registro.acoes[]list-condicionalConjunto de ações
retorno.registros[].registro.acoes[].acao.idint-condicionalID da ação na Olist

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/crm.incluir.assunto.php \
  -d 'token=SEU_TOKEN&formato=json&assunto={
    "cliente": {
      "nome": "Cliente Teste",
      "tipo_pessoa": "F",
      "cpf_cnpj": "12345678900",
      "fone": "5199999999"
    },
    "descricao_assunto": "Teste de assunto",
    "estagio_assunto": "1",
    "acoes": [
      {
        "acao": {
          "descricao_acao": "Realizar contato",
          "tipo_data_acao": "Q",
          "situacao_acao": "0"
        }
      }
    ]
  }'

​
Exemplos de retorno

​
Erro - Token inválido

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

​
Erro - Duplicidade

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "30",
          "erros": [
            {
              "erro": "Registro em duplicidade"
            }
          ]
        }
      }
    ]
  }
}

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "OK",
          "id": "49644545",
          "acoes": [
            {
              "acao": {
                "id": "49644546"
              }
            },
            {
              "acao": {
                "id": "49644547"
              }
            }
          ]
        }
      }
    ]
  }
}