Skip to main content
PATCH
Update company

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Path Parameters

id
string
required

Company ID (cmp_*)

Body

application/json
icon
object

Company icon/logo

Response

Company updated

object
string
required

Object type

Example:

"page"

id
string
required

Unique identifier

Example:

"p_abc123"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T14:45:00.000Z"

document
string
required
Example:

"00000000000191"

archived
boolean
default:false
required
createdBy
Created by · object

Principal who created this object

Example:
updatedBy
Updated by · object

Principal who last updated this object

Example:
tradeName
string
icon
Icon · object | null
archivedAt
string
archivedBy
string
addressState
string
addressType
string
addressStreet
string
addressNumber
string
addressComplement
string
addressNeighborhood
string
addressZipCode
string
addressCity
string
registrationStatus
string
registrationStatusDate
string | null
email
string | null
phones
string[] | null
companySize
string | null
capital
string | null
simplesOption
boolean | null
simplesOptionDate
string | null
meiOption
boolean | null
meiOptionDate
string | null
mainCnae
Main CNAE · object
secondaryCnaes
Secondary CNAEs · object[]
isHeadquarter
boolean
activityStartDate
string | null