Skip to main content
POST
Create a company

Authorizations

X-API-KEY
string
header
required

Body

application/json

Company to create

name
string
required

Name is the company's display name.

Example:

"Acme Inc."

customFields
object

CustomFields holds custom field values keyed by custom field key.

fallbackColor
string

FallbackColor is the hex color used as the icon background when no image is set.

Example:

"#4F46E5"

iconImageUrl
string<uri>

IconImageUrl is the URL of the company's icon image.

Example:

"https://example.com/icon.png"

isPlaceholder
boolean

IsPlaceholder marks the company as a placeholder record.

Example:

false

Response

OK

createdAt
string<date-time>

Created is the RFC 3339 timestamp at which the object was created.

Example:

"2024-01-15T09:30:00Z"

customFields
object

CustomFields holds custom field values for the company, keyed by custom field key.

deleted
boolean

Deleted is true when the object has been deleted; present only on delete responses.

Example:

true

fallbackColor
string

FallbackColor is the hex color (e.g. "#4F46E5") used as the background when no icon image is set. The native pattern documents intent; the constraint is re-applied to the spec by the enrich-openapi post-processing step.

Pattern: ^#[0-9a-fA-F]{6}$
Example:

"#4F46E5"

iconImageUrl
string<uri>

AvatarImageURL is the URL of the company's icon image.

Example:

"https://portal.example.com/icons/acme.png"

id
string

ID is the unique identifier of the object.

Example:

"550e8400-e29b-41d4-a716-446655440000"

isPlaceholder
boolean

IsPlaceholder is true when the company was auto-created as a placeholder. Read-only.

Example:

false

name
string

Name is the company's display name. Required on create.

Example:

"Acme Inc"

object
enum<string>

Object is the type of the object (e.g. "client", "company").

Available options:
client,
internalUser,
company,
customField,
customFieldOption,
file,
fileChannel,
folder,
messageChannel,
message,
notification
updatedAt
string<date-time>

Updated is the RFC 3339 timestamp at which the object was last updated.

Example:

"2024-02-20T14:05:00Z"