POST /api/v2/organizations
You must provide a unique name for each organization. Normally
the system doesn't allow records to be created with identical names.
However, a race condition can occur if you make two or more identical
POSTs very close to each other, causing the records to have identical
organization names.
Allowed For
- Admins
- Agents assigned to a custom role with permissions to manage organizations (Enterprise only)
Servers
- https://{subdomain}.{domain}.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
organization |
Object | Yes | |
organization.domain_names[] |
Array | No |
An array of domain names associated with this organization |
organization.external_id |
String | No |
A unique external id to associate organizations to an external record. The id is case-insensitive. For example, "company1" and "Company1" are considered the same |
organization.url |
String | No |
The API url of this organization |
organization.organization_fields |
Object | No |
Custom fields for this organization. See Custom organization fields |
organization.organization_fields.TriggerCategoryId |
String | No | |
organization.details |
String | No |
Any details obout the organization, such as the address |
organization.shared_tickets |
Boolean | No |
End users in this organization are able to see each other's tickets |
organization.updated_at |
String | No |
The time of the last update of the organization |
organization.id |
Integer | No |
Automatically assigned when the organization is created |
organization.shared_comments |
Boolean | No |
End users in this organization are able to comment on each other's tickets |
organization.name |
String | Yes |
A unique name for the organization |
organization.notes |
String | No |
Any notes you have about the organization |
organization.tags[] |
Array | No |
The tags of the organization |
organization.created_at |
String | No |
The time the organization was created |
organization.group_id |
Integer | No |
New tickets from users in this organization are automatically put in this group |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.