Sign in
Companies

Update company attributes

Updates the attributes of a company based on the company ID.

Any one of the following roles is required for this endpoint:

Legacy RoleEquivalent Permission Set Role
org.user.company.writeorg.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 null
  • At date-time or null
  • Str string or null, length: [ 0 .. 1024 ] characters
  • Txt string or null, length: [ 0 .. 1024 ] characters
  • Bool boolean or null
  • Url string or null, format: uri
put/companies/{id}

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/companies/{id}
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

idstring required
Example:58224b3eaa5f92110005d61e

Unique ID of the company.

Request body

namestring
externalIdstring nullable
avatarUrlstring uri nullable
employeeCountnumber
tagsstring[]
customobject
defaultLangstring nullable
revnumber
deletedboolean nullable

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.