PATCH /v1/companies/{id}
PATCH
/v1/companies/{id}
const url = 'https://seu-endereco-da-api/v1/companies/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
name
string
document
string
website
string
email
string format: email
phoneNumber
string
segment
string
size
string
address
object
cep
string
rua
string
numero
string
bairro
string
cidade
string
estado
string
ownerUserId
string format: uuid
originId
string format: uuid
note
string
attributes
object
key
additional properties
any
tagIds
Array<string>
Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
name
required
string
document
required
CNPJ, digits only
string
website
required
string
email
required
string
phoneNumber
required
string
segment
required
string
size
required
string
owner
required
object
id
required
string
name
required
string
avatarUrl
required
string
origin
required
object
id
required
string
name
required
string
color
required
string
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
contactCount
required
number
openDealCount
required
number
openDealValueCents
required
number
wonValueCents
required
number
lastActivityAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
address
required
object
cep
required
string
rua
required
string
numero
required
string
bairro
required
string
cidade
required
string
estado
required
string
note
required
string
attributes
required
object
hiddenAttributes
required
Array<string>
people
required
Array<object>
object
id
required
string
name
required
string
phoneNumber
required
string
jobTitle
required
string
provider
required
string
channel
required
string
profilePicUrl
required
string
linkedAt
required
string format: date-time
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
lastWonAt
required
string format: date-time
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
value
required
number
status
required
string
wonAt
required
string format: date-time
lostAt
required
string format: date-time
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