POST /api/v2/organizations/{organization_id}/merge
Merges two organizations by moving all users, tickets, and domain names from the organization specified by {organization_id} to the organization specified by winner_id. After the merge:
- The "losing" organization will be deleted.
- Other organization fields and their values will not be carried over to the "winning" organization.
- The merge operation creates an
Organization Mergerecord which contains a status indicating the progress of the merge.
Note: This operation is irreversible.
Merge Statuses
| Status | Description |
|---|---|
| new | A job has been queued to merge the two organizations. |
| in progress | The job to merge the two organizations has started. |
| error | An error occurred during the merge job. The merge can be retried by repeating the API call. |
| complete | The merge has been completed successfully. |
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id |
Integer | Yes |
The ID of an organization |
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_merge |
Object | No | |
organization_merge.winner_id |
Integer | No |
The id of the winning organization. |
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.