put https://api.kustomerapp.com/v1/companies/
Updates the attributes of a company based on the company ID.
Any one of the following roles is required for this endpoint:
Legacy Role | Equivalent Permission Set Role |
---|---|
org.user.company.write | org.permission.company.update |
Note
This endpoint is subject to Object Rate Limiting, which limits how many updates a single user can make to a single company attribute. To learn more, see Rate limiting.
Custom Attributes
Custom attributes are optional and allow you to specify
custom key-value pairs.
Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:
Naming Suffix
Num
number or nullAt
date-time or nullStr
string or null, length: [ 0 .. 1024 ] charactersTxt
string or null, length: [ 0 .. 1024 ] charactersBool
boolean or nullUrl
string or null, format: uri