Skip to main content

​
Endpoint

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

​
Parâmetros

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

​
Layout do parâmetro “acao”

CampoTipoTamanhoOcorrênciaDescrição
acao.id_assuntoint-obrigatórioNúmero de identificação do assunto na Olist
acao.descricao_acaostring-obrigatórioDescrição da ação
acao.tipo_data_acaostring1obrigatórioCódigo conforme tabela de Tipos de data da ação
acao.data_acaodate20opcionalData da ação (formato dd/mm/yyyy) (1)
acao.situacao_acaostring-opcionalCódigo conforme tabela de Situações da ação (2)
acao.usuariostring-opcionalLogin do usuário responsável pela ação
(1) Campo data_acao é considerado apenas quando tipo_data_acao = “D”
(2) 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-condicionalElemento para representar uma ação
retorno.registros[].registro.sequenciaint-condicionalNúmero sequencial
retorno.registros[].registro.statusstring-condicional”OK” ou “Erro”
retorno.registros[].registro.codigo_erroint-condicionalConforme tabela “Códigos de erro”
retorno.registros[].registro.erros[]list-condicionalLista dos erros [0..n]
retorno.registros[].registro.erros[].errostring-condicionalDescrição do erro
retorno.registros[].registro.idint-condicionalNúmero de identificação da ação na Olist

​
Exemplo de parâmetro

{
  "acao": {
    "id_assunto": "1235678",
    "descricao_acao": "Contatar",
    "tipo_data_acao": "D",
    "data_acao": "15/01/2015",
    "situacao_acao": "1"
  }
}

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/crm.incluir.acao.assunto.php \
  -d 'token=SEU_TOKEN&formato=json&acao={
    "id_assunto": "1235678",
    "descricao_acao": "Contatar",
    "tipo_data_acao": "D",
    "data_acao": "15/01/2015",
    "situacao_acao": "1"
  }'

​
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"
        }
      }
    ]
  }
}

​
Observações

  • Se o campo usuario não for enviado, nenhum usuário é atribuído à ação
  • Formato de data: dd/mm/yyyy (exemplo: “01/01/2012”)