Sign in
Companies

Create company

Creates a new company.

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

Legacy RoleEquivalent Permission Set Role
org.user.company.writeorg.permission.company.create

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
post/companies

Request

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

Request body

namestring required

The name of the company. The minimum length is 3 and the maximum is 255.

externalIdstring

The third party application ID for this company, if applicable. The maximum length is 256.

avatarUrlstring uri nullable

The URL for the avatar image of this company.

employeeCountnumber

The number of customers associated with this company.

tagsstring[]
createdAtstring date-time

The date and time the company object was created in Kustomer.

importedAtstring date-time

The date and time the company was imported from an external system.

revnumber
customobject
defaultLangstring nullable

Response

Created

Changes

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