Pular para o conteúdo

PATCH /v1/companies/{id}

PATCH
/v1/companies/{id}
curl --request PATCH \
--url https://seu-endereco-da-api/v1/companies/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "document": "example", "website": "example", "email": "hello@example.com", "phoneNumber": "example", "segment": "example", "size": "micro", "address": { "cep": "example", "rua": "example", "numero": "example", "bairro": "example", "cidade": "example", "estado": "example" }, "ownerUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "originId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "note": "example", "attributes": {}, "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Permissão que a Chave de acesso precisa: Criar e editar empresas (companies:manage).

id
required
string
Media typeapplication/json
object
name
string
>= 1 characters <= 160 characters
document
string
nullable <= 40 characters
website
string
nullable <= 200 characters
email
string format: email
nullable
phoneNumber
string
nullable <= 40 characters
segment
string
nullable <= 80 characters
size
string
nullable
Allowed values: micro pequena media grande
address
object
cep
string
nullable <= 120 characters
rua
string
nullable <= 120 characters
numero
string
nullable <= 120 characters
bairro
string
nullable <= 120 characters
cidade
string
nullable <= 120 characters
estado
string
nullable <= 120 characters
ownerUserId
string format: uuid
nullable
originId
string format: uuid
nullable
note
string
nullable <= 4000 characters
attributes
object
key
additional properties
any
tagIds
Array<string>
Media typeapplication/json
object
id
required
string
name
required
string
document
required

CNPJ, digits only

string
nullable
website
required
string
nullable
email
required
string
nullable
phoneNumber
required
string
nullable
segment
required
string
nullable
size
required
string
nullable
Allowed values: micro pequena media grande
owner
required
object
id
required
string
name
required
string
nullable
avatarUrl
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
contactCount
required
number
openDealCount
required
number
openDealValueCents
required
number
wonValueCents
required
number
lastActivityAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
address
required
object
cep
required
string
nullable
rua
required
string
nullable
numero
required
string
nullable
bairro
required
string
nullable
cidade
required
string
nullable
estado
required
string
nullable
note
required
string
nullable
attributes
required
object
hiddenAttributes
required
Array<string>
people
required
Array<object>
object
id
required
string
name
required
string
phoneNumber
required
string
nullable
jobTitle
required
string
nullable
provider
required
string
channel
required
string
profilePicUrl
required
string
nullable
linkedAt
required
string format: date-time
nullable
dealSummary
required
object
openCount
required
number
openValueCents
required
number
wonCount
required
number
wonValueCents
required
number
lostCount
required
number
metrics
required
object
wonCount
required
number
wonValueCents
required
number
avgTicketCents
required
number
avgCycleDays
required
number
nullable
lastWonAt
required
string format: date-time
nullable
recentDeals
required
Array<object>
object
id
required
string
number
required
number
pipelineId
required
string
pipelineName
required
string
stageId
required
string
stageName
required
string
stageColorKey
required
string
title
required
string
nullable
value
required
number
status
required
string
Allowed values: open won lost
wonAt
required
string format: date-time
nullable
lostAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
canEdit
required

The caller holds deals:manage and the deal policy lets them act on this deal

boolean

Example

{
"size": "micro",
"recentDeals": [
{
"status": "open"
}
]
}

Company_name_taken | company_document_taken