Gestão de Pessoas

Pessoas

Criar Pessoa

Cria um novo registro de pessoa na base da plataforma.

Request

CODE

POST https://api.cvortex.com/v1/person

Header

CODE

Authorization

Parâmetros de body

Nome	Tipo	Descrição	Obrigatório
`contactsToAdd`	array	Lista de contatos a serem adicionados. Cada item contém `fieldLabel` e `value`.	Não
`contactsToRemove`	array	Lista de contatos a serem removidos. Não utilizado no exemplo.	Não
`details`	array	Detalhes adicionais da pessoa. Cada item contém `fieldUUID`, `fieldLabel` e `value`.	Não
`fields`	array	Informações principais da pessoa. Cada item contém `fieldLabel` e `value`.	Sim

Estrutura dos arrays contactsToAdd, contactsToRemove, details, fields

Nome	Tipo	Descrição	Obrigatório
`fieldLabel`	string	Nome do campo	Sim
`fieldUUID`	string	Identificador único do campo (para `details`)	Não
`value`	string	Valor associado ao campo	Sim

Exemplo de Payload

JSON

{
  "contactsToAdd": [
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "EMAIL"
        },
        {
          "fieldLabel": "Value",
          "value": "alice.clara.drumond@guiandotelecom.com.br"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "MOBILE_PHONE"
        },
        {
          "fieldLabel": "Value",
          "value": "21985160494"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "LANDLINE_PHONE"
        },
        {
          "fieldLabel": "Value",
          "value": "2127448807"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "WHATSAPP"
        },
        {
          "fieldLabel": "Value",
          "value": "21985160494"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "WEBCHAT"
        },
        {
          "fieldLabel": "Value",
          "value": "67f7c6440732aa3e366e5000"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "TELEGRAM"
        },
        {
          "fieldLabel": "Value",
          "value": "alice.clara.drumond"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "INSTAGRAM"
        },
        {
          "fieldLabel": "Value",
          "value": "alice.clara.drumond10"
        }        
      ]
    },
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "MESSENGER"
        },
        {
          "fieldLabel": "Value",
          "value": "9478174898924321"
        }        
      ]
    }
  ],
  "contactsToRemove": [],
  "details": [
    {
      "fieldUUID": "bfb0d1bbc08448278a6c9315a4443fc6",
      "fieldLabel": "nome da mae",
      "value": "Patrícia Elza Marlene"
    },
    {
      "fieldUUID": "50da4da8174747e7887920aca05eef7d",
      "fieldLabel": "nome do pai",
      "value": "Kevin André Drumond"
    },
    {
      "fieldUUID": "6ef81032d05b44e4846f92647b1860d6",
      "fieldLabel": "data de nascimento",
      "value": "-220309200000"
    }
  ],
  "fields": [
    {
      "fieldLabel": "Document",
      "value": "631.127.437-13"
    },
    {
      "fieldLabel": "Full Name",
      "value": "Alice Clara B Guimenez"
    }    
  ]
}

Response

CODE	Descrição
`200`	Pessoa criada com sucesso

Exemplo de Response

JSON

{
    "document": "631.127.437-13",
    "easyId": "15787",
    "fullName": "Alice Clara B Guimenez",
    "id": "4b640da5-8f61-4a9d-8871-9714c3096fb4",
    "personDetails": [
        {
            "Created at": 1747938561046,
            "Created by": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
            "Deleted": false,
            "Person Id": "4b640da5-8f61-4a9d-8871-9714c3096fb4",
            "Updated at": 1747938561046,
            "Updated by": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
            "_id": "d5c04eb8-6664-4a02-bfa1-440bcd60f857",
            "_version": "0",
            "data de nascimento": -220309200000,
            "nome da mae": "Patrícia Elza Marlene",
            "nome do pai": "Kevin André Drumond"
        }
    ]
}

Atualizar Pessoa

Atualiza um registro existente de pessoa.

Request

CODE

PUT https://api.cvortex.com/v1/person

Header

CODE

Authorization

Parâmetros de body

Nome	Tipo	Descrição	Obrigatório
`contactsToAdd`	array	Lista de contatos a serem adicionados. Cada item contém `fieldLabel` e `value`.	Não
`contactsToRemove`	array	Lista de contatos a serem removidos. Não utilizado no exemplo.	Não
`details`	array	Detalhes adicionais da pessoa. Cada item contém `fieldUUID`, `fieldLabel` e `value`.	Não
`fields`	array	Deve conter ao menos o `Id` da pessoa (`fieldLabel: "Id"`). Pode conter outros dados a atualizar.	Sim

Estrutura dos arrays contactsToAdd, contactsToRemove, details, fields

Nome	Tipo	Descrição	Obrigatório
`fieldLabel`	string	Nome do campo	Sim
`fieldUUID`	string	Identificador único do campo (somente em `details`)	Não
`value`	string	Valor associado ao campo	Sim

Exemplo de Payload

JSON

{
  "contactsToAdd": [
    {
      "fields": [
        {
          "fieldLabel": "Contact Type",
          "value": "WHATSAPP"
        },
        {
          "fieldLabel": "Value",
          "value": "75991009528"
        }        
      ]
    }
  ],
  "contactsToRemove": [],
  "details": [],
  "fields": [
    {
      "fieldLabel": "Id",
      "value": "4b640da5-8f61-4a9d-8871-9714c3096fb4"
    }   
  ]
}

Response

CODE	Descrição
`200`	Pessoa criada com sucesso

Exemplo de Response

JSON

{
    "id": "4b640da5-8f61-4a9d-8871-9714c3096fb4",
    "fullName": "Alice Clara B Guimenez",
    "document": "631.127.437-13",
    "easyId": "15787",
    "personDetails": [
        {
            "nome do pai": "Kevin André Drumond",
            "data de nascimento": -220309200000,
            "Updated by": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
            "Deleted": false,
            "Created by": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
            "_id": "d5c04eb8-6664-4a02-bfa1-440bcd60f857",
            "Updated at": 1747938561046,
            "nome da mae": "Patrícia Elza Marlene",
            "Person Id": "4b640da5-8f61-4a9d-8871-9714c3096fb4",
            "_version": "0",
            "Created at": 1747938561046
        }
    ]
}

Buscar pessoa (v1)

Permite buscar uma pessoa pelo seu nome e documento.

Request

CODE

GET https://api.cvortex.com/v1/person

Header

CODE

Authorization

Parâmetros de URI

Parâmetro	Descrição	Obrigatório
`document`	Documento completo da pessoa	Não
`eqFullName`	Nome completo da pessoa (exato)	Não
`fullName`	Parte do nome da pessoa (busca parcial)	Não
`email`	E-mail da pessoa	Não
`jobTitle`	Cargo da pessoa	Não

Response

JSON

[
{
"document": "string",
"easyId": "string",
"email": "string",
"jobTitle": "string",
"fullName": "string",
"id": "string"
}
]

Buscar pessoa (v2)

Permite consultar registros de pessoas a partir de um identificador, como documento. Retorna os dados principais da pessoa e seus detalhes associados.

Request

CODE

GET https://api.cvortex.io/v2/person?document=000.000.000-00

Header

CODE

Authorization

Parâmetros de URI

Nome	Tipo	Descrição	Obrigatório
`document`	string	Documento da pessoa (ex: CPF)	Sim

Response

CODE	Descrição
`200`	Operação realizada com sucesso

Exemplo de Response

JSON

[
  {
    "id": "4b640da5-8f61-4a9d-8871-9714c3096fb4",
    "fullName": "Alice Clara B Guimenez",
    "document": "000.000.000-00",
    "easyId": "15787",
    "personDetails": [
      {
        "nome do pai": "Kevin André Drumond",
        "data de nascimento": -220309200000,
        "Updated by": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
        "Deleted": false,
        "Created by": "59105e3f-c1a1-4ed1-a4ed-50d4ac408be3",
        "_id": "d5c04eb8-6664-4a02-bfa1-440bcd60f857",
        "Updated at": 1747938561046,
        "nome da mae": "Patrícia Elza Marlene",
        "Person Id": "4b640da5-8f61-4a9d-8871-9714c3096fb4",
        "_version": "0",
        "Created at": 1747938561046
      }
    ]
  }
]

Contar pessoas

Permite contar a quantidade de pessoas conforme os filtros informados.

Request

CODE

GET https://api.cvortex.com/v1/person/count

Header

CODE

Authorization

Parâmetros de URI

Parâmetro	Descrição	Obrigatório
`document`	Documento completo da pessoa	Não
`eqFullName`	Nome completo da pessoa (exato)	Não
`fullName`	Parte do nome da pessoa (busca parcial)	Não
`email`	E-mail da pessoa	Não
`jobTitle`	Cargo da pessoa	Não

Response

CODE

number

Encontrar Pessoa por Nome, Documento, Contatos

Permite buscar uma pessoa por nome, documento, e contatos.

Request

CODE

GET https://api.cvortex.com/v1/person/value?limit=[LIMIT]&value=[VALOR]

Header

CODE

Authorization

Parâmetros de query

Nome	Tipo	Descrição	Obrigatório
`limit`	`inteiro`	Limite de resultados	Não
`value`	`string`	Valor para busca (nome, email, etc)	Sim

Response

CODE	Descrição
`200`	Operação realizada com sucesso

Exemplo de request

CODE

https://api.cvortex.com/v1/person/value?limit=1&value=vitor

Exemplo de resposta

CODE

https://api.cvortex.com/v1/person/value?limit=1&value=vitor

JSON

[
  {
    "id": "3e3e58bf-67bb-4de4-8ab7-42644642971e",
    "fullName": "vitor-dois",
    "easyId": "91",
    "active": true,
    "createdAt": 1680224990213,
    "updatedAt": 1696013284498,
    "createdBy": "default-user",
    "updatedBy": "d447a00a-53ad-4714-88b3-d81b6632fd19",
    "deleted": false,
    "contacts": [
      {
        "id": "fff3580e-0ba0-431c-b944-60f90726ebb4",
        "contactType": "MOBILE_PHONE",
        "value": "34991131072",
        "channelType": "VOICE",
        "createdAt": 1680224990398,
        "active": true,
        "deleted": false
      }
    ]
  }
]

Permitir Junção de Duas Pessoas (Merge)

Ao executar essa API a pessoa de destino receberá todos os atendimentos e contatos da pessoa que está sendo juntada. A pessoa juntada será excluída após o processo e ele não pode ser desfeito.

Request

CODE

POST https://api.cvortex.com/v1/person/merge/{personId}/{personIdToMerge}

"personId" (id da pessoa que vai ficar ativa)
"personIdToMerge" (id da pessoa que vai ser mergeada na de cima)

Exemplo

CODE

POST https://api.cvortex.com/v1/person/merge/e887f7f1-3cdd-4b01-bc3a-5421d23d153s/e887f7f1-3cdd-4b01-bc3a-5421d29d153a