Contacts

Módulo de Gestão de Contatos. Este recurso é dependente do ID do módulo de gestão de contatos associado ao Projeto. Para descobrir o ID correto consulte a lista de componentes do projeto!

Listagem de contatos

get

Retorna uma lista de contatos para um dado componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

Parâmetros de consulta

pageinteger · intOpcional

número da página

limitinteger · intOpcional

número máximo de items na página (máx. 100)

Respostas

200

Sucesso

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

get

/contact/api/v1/{component_id}/contacts

HTTPcURLJavaScriptPython

GET /contact/api/v1/{component_id}/contacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-03-12T00:33:20.254Z",
      "updated_at": "2026-03-12T00:33:20.254Z",
      "created_by": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "John Smith",
        "email": "[e-mail]"
      },
      "attributes": {
        "Nome": "John Doe",
        "E-mail": "[e-mail]",
        "Telefone": "5511999999999"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1
  }
}

Criação de contato

post

Cria um contato em um componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

Corpo

application/json

attributesobjectObrigatório

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Respostas

201

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

post

/contact/api/v1/{component_id}/contacts

HTTPcURLJavaScriptPython

POST /contact/api/v1/{component_id}/contacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-03-12T00:33:20.254Z",
  "updated_at": "2026-03-12T00:33:20.254Z",
  "created_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Smith",
    "email": "[e-mail]"
  },
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

Dados do contato

get

Retorna os dados de um contato de um componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

contact_idstring · uuidObrigatório

ID do contato

Respostas

200

Sucesso

application/json

idstring · uuidOpcional

ID do contato

created_atstring · date-timeOpcional

Data da criação

updated_atstring · date-timeOpcional

Data da última atualização

attributesobjectOpcional

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Example: {"Nome":"John Doe","E-mail":"[e-mail]","Telefone":"5511999999999"}

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

get

/contact/api/v1/{component_id}/contacts/{contact_id}

HTTPcURLJavaScriptPython

GET /contact/api/v1/{component_id}/contacts/{contact_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-03-12T00:33:20.254Z",
  "updated_at": "2026-03-12T00:33:20.254Z",
  "created_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Smith",
    "email": "[e-mail]"
  },
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

Excluir contato

delete

Excluir um contato de lista de contatos de um componente. O contato não pode ser visualizado, modificado ou recuperado após exclusão!

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

contact_idstring · uuidObrigatório

ID do contato

Respostas

200

Sucesso

application/json

idstring · uuidOpcional

ID do contato

created_atstring · date-timeOpcional

Data da criação

updated_atstring · date-timeOpcional

Data da última atualização

attributesobjectOpcional

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Example: {"Nome":"John Doe","E-mail":"[e-mail]","Telefone":"5511999999999"}

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

delete

/contact/api/v1/{component_id}/contacts/{contact_id}

HTTPcURLJavaScriptPython

DELETE /contact/api/v1/{component_id}/contacts/{contact_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-03-12T00:33:20.254Z",
  "updated_at": "2026-03-12T00:33:20.254Z",
  "created_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Smith",
    "email": "[e-mail]"
  },
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

Atualização de contato

patch

Atualiza os dados de um contato de um componente. Afeta somente atributos que estão no corpo da requisição.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

contact_idstring · uuidObrigatório

ID do contato

Corpo

application/json

attributesobjectObrigatório

Pares Chave/Valor no formato [Nome do atributo]: [Valor do atributo]

Respostas

201

Sucesso

application/json

400

Erro no formato dos dados da requisição

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

422

Erro ao processar os dados

application/json

patch

/contact/api/v1/{component_id}/contacts/{contact_id}

HTTPcURLJavaScriptPython

PATCH /contact/api/v1/{component_id}/contacts/{contact_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "attributes": {
    "E-mail": "[e-mail]"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-03-12T00:33:20.254Z",
  "updated_at": "2026-03-12T00:33:20.254Z",
  "created_by": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Smith",
    "email": "[e-mail]"
  },
  "attributes": {
    "Nome": "John Doe",
    "E-mail": "[e-mail]",
    "Telefone": "5511999999999"
  }
}

Estrutura dos contatos

get

Retorna a estrutura dinâmica dos contatos do componente.

Autorizações

api_key

AuthorizationstringObrigatório

Chave de API

Parâmetros de rota

component_idstring · uuidObrigatório

ID do componente

Respostas

200

Sucesso

application/json

401

Chave de API inválida/ausente

403

Usuário sem autorização

application/json

get

/contact/api/v1/{component_id}/schema

HTTPcURLJavaScriptPython

GET /contact/api/v1/{component_id}/schema HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "attributes": [
    {
      "id": "3763e13a-0273-401c-9c16-b7afa9aef134",
      "name": "Nome",
      "content_type": "string",
      "visibility": "show"
    },
    {
      "id": "c8f474d1-fbce-4270-98cb-aa5ea6cc3551",
      "name": "E-mail",
      "content_type": "email",
      "visibility": "show",
      "example_value": "[e-mail]"
    },
    {
      "id": "88e1ffd1-16d2-4d41-8c7c-8d5fbd001aad",
      "name": "Telefone",
      "content_type": "phone1",
      "visibility": "show",
      "example_value": "(11) 99999-9999"
    }
  ]
}