Metadados envio de comunicação

Aqui você irá encontrar um modelo dos parâmetros do customer, que deverão ser encaminhados à Zenvia para o envio das comunicações.

Customer é um objeto que representa o cliente dentro da plataforma.

Body exemplo

{
  "id": "111.111.111-11",
  "name": "João da Silva",
  "nickname": "JoaoSilva",
  "personType": "natural",
  "gender": "male",
  "maritalStatus": "married",
  "birthDate": "1980-07-15T03:00:00.000Z",
  "emails": [
    {
      "address": "journey@d1.cx",
      "kind": "comercial"
    }
  ],
  "phones": [
    {
      "number": "5511999999999",
      "kind": "cellphone"
    }
  ],
  "addresses": [
    {
      "street": "Rua João da Silva Filho Junior",
      "number": "999",
      "complement": "Complemento",
      "neighborhood": "João da Silva Filho",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "12345-000",
      "country": {
        "id": "76",
        "name": "Brasil"
      },
      "kind": "residential",
      "geocode": [
        1200,
        92929
      ]
    }
  ],
  "documents": {
    "cpf": "111.111.111-11"
  }
}

Atributos

Campo Files

{
  "type": "storage", 
  "mode": "Attachment", -> (Attachment e Link).
  "isMain": true,
  "filename": "fatura directone",
  "description": "Fatura A",
  "correlationId": "46299F1DF4C9C9CCEDB4D49DAE6C254",
  "nodes": [
    {
      "name": "E-mail 2", -> Nome do canal.
      "mode": "Attachment"
    }
  ]
}

Atributos

Campos tipo Date

É importante que todos os campos do tipo date sejam enviados utilizando o formato ISO-86001.

O controle do fuso horário assim como o horário de verão é de responsabilidade de quem está chamando a API.

Exemplo: 1980-07-15T03:00:00.000Z

Campo Variables

"variables":{
      "var_linkBoleto":"https://boletoonline.acme.gov.br/imprimir/",
      "var_digital1":"012345678901234",
      "var_digital2":"01234567890123401234567890134",
      "var_primeiro_nome":"Transferência Boleto",
      "var_proposta":"0123456",
      "var_doc_total":"15,37",
      "var_link":"https://lnk.acme.io/",
      "var_vencimento":"1980-12-31T23:59:59.000Z",
      "var_nomeVendedor":"Rua João da Silva Filho",
      "var_cartao":"super cartao",
      "var_celularVendedor":"551199999999"
   }

Atributos

Last updated