Sign in

v1

latestSwagger 2.02026-08-065854114.9 KB
organizations

Search for an organization by name or document number (CNPJ).

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 organization.

post/organizations/upsert

Request body

namestring required

Display name (Nome fantasia) that will be used to find (exact match) or create.

legalNamestring

Legal name (Razão social).

cnpjstring

Legal document number (CNPJ).

descriptionstring

Your description of this organization.

logostring url

Logo image URL.

websitestring url

Homepage URL.

ranking0 | 1 | 2 | 3 | 4 | 5

Ranking displayed as stars in the organization page.

authorinteger

User ID of the author of this organization.

ownerUserinteger

User ID or email of the owner of this organization.

leadOrigininteger

Lead origin ID or name.

categoryinteger

Category ID or name.

sectorinteger

Sector ID or name.

productsinteger[]

Array of product IDs.

allowedUsersinteger[]

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

allowToAllUserstrue

Set true if this organization 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"
    }
  }
}