Zendesk

Zendesk Organization Merges API

Zendesks Organization Merges API lets you consolidate two organizations into one clean record by merging a source organization into a target. During a merge, all users belonging to the source organization are moved to the target, and tickets associated with the source (as requester or via organization) are re-associated to the target, preserving ticket history and continuity.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/organization-merges-openapi-original.yml

OpenAPI Specification

openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Organization Merges
  description: Needs a description.
paths:
  /api/v2/organization_merges/{organization_merge_id}:
    parameters:
      - $ref: '#/components/parameters/OrganizationMergeId'
    get:
      operationId: ShowOrganizationMerge
      tags:
        - Organizations
      summary: Zendesk Get  Api V2 Organization_merges Organization_merge_id
      description: >
        Retrieves the details of a specific organization merge operation. This
        endpoint is useful for obtaining the status and outcome of a merge that
        was previously initiated. It provides information such as the winning
        and losing organization IDs, the status of the merge, and the associated
        URLs.


        This endpoint can be used to determine if a merge is still in progress,
        has completed successfully, or has encountered an error.


        #### Allowed For


        * Admins
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationMergeResponse'
              examples:
                default:
                  $ref: '#/components/examples/OrganizationMergeResponseExample'
components:
  schemas:
    OrganizationMergeResponse:
      type: object
      properties:
        organization_merge:
          type: object
          properties:
            id:
              type: string
              format: string
            loser_id:
              type: integer
            status:
              type: string
              enum:
                - new
                - in_progress
                - error
                - complete
            url:
              type: string
              format: string
            winner_id:
              type: integer
          required:
            - id
            - url
            - loser_id
            - winner_id
            - status
tags:
  - name: Organizations