Sign in

v1

latestSwagger 2.02026-08-065854114.9 KB
people

Search for a person by cpf or email.

If found, update it, otherwise, create a new one.

This endpoint is very useful if you want to avoid verifying for duplicates before creating a new person.

post/people/upsert

Request body

namestring

Name of this person.

cpfstring

Legal document number (CPF).

organizationinteger

Organization ID.

rolestring

Person's role in their organization.

ranking0 | 1 | 2 | 3 | 4 | 5

Ranking displayed as stars in the person's page.

descriptionstring

Your description of this person.

{"stackTrail":"components:schemas:postPeopleUpsert:properties:birthday","oasType":"schema","type":"unknown","description":"Person's birthdate with or without year."}
authorinteger

User ID of the author of this person.

ownerUserinteger

User ID or email of the owner of this person.

leadOrigininteger

Lead origin ID or name.

categoryinteger

Category ID or name.

productsinteger[]

Array of product IDS.

allowedUsersinteger[]

Array of IDs of users that should be able to see this person.

allowToAllUserstrue

Set true if this person should be visible to all users.

customFieldsobject

Custom Fields information. A key-value map where each key is the identifier (name) of a custom field and the value is the desired content.

Example: { "customFields": { "custom_field_identifier_1" : "desired value", "custom_field_identifier_2" : "desired value 2" } }

Response

OK

Example response

{
  "data": {
    "contact": {
      "work": "(99) 9999-9999",
      "mobile": "(99) 99999-9999",
      "whatsapp": "+5511999999999"
    },
    "address": {
      "postalCode": "99999-999"
    }
  }
}