Partner Change Request Management

Endpoints for managing partner change requests

Get list of Partner Change Requests

get

This endpoint fetches list of all partner change requests to your partner hub.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Query parameters

sortstring · enumOptional

Sort results by partner change request fields

Example: created_atPossible values:

offsetintegerOptional

Number of results to skip

Example: 10

limitintegerOptional

Maximum number of results to return

Example: 10

Responses

200

Successful response

application/json

limitintegerOptional

Maximum number of results to return

Example: 10

offsetintegerOptional

Number of results to skip

Example: 0

sortstring[]Optional

Sort results by partner change request fields

Example: ["-created_at"]

totalintegerOptional

Total number of results

Example: 1

countintegerOptional

Number of results returned

Example: 1

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/selective_partner_change_requests

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/selective_partner_change_requests HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "limit": 10,
  "offset": 0,
  "sort": [
    "-created_at"
  ],
  "filters": {
    "status": {
      "like": "completed"
    }
  },
  "total": 1,
  "count": 1,
  "partner_change_requests": [
    {
      "id": "examplePCR",
      "status": "completed",
      "is_full_migration": true,
      "source_client_id": "exampleCL",
      "target_client_id": "exnewCL",
      "source_partner_id": "exoldPA",
      "target_partner_id": "exnewPA",
      "migrated_channels": [
        "abOd1CH",
        "oe78HsCH"
      ],
      "created_at": "2023-01-02T12:00:00Z",
      "modified_at": "2023-01-04T12:00:00Z"
    }
  ]
}

Approve Partner Change Request

post

This endpoint approves a partner change request by ID. After approval, the background process will start and a client will be migrated.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

pcr_idstringRequired

The ID of the partner change request.

Example: random-string-id

Responses

200

Successful response

application/json

idstringOptional

ID of partner change request object.

Example: examplePCR

statusstringOptional

Status of partner change request object. Possible values: created,pending,completed,failed

Example: completed

is_full_migrationbooleanOptional

True means all client channels were/will be moved in this pcr. False means partial migration.

Example: true

source_client_idstringOptional

Original client id.

Example: exampleCL

target_client_idstringOptional

The copy/clone client id that will be created under target partner (only required for partial migrations).

Example: exnewCL

source_partner_idstringOptional

Original partner id.

Example: exoldPA

target_partner_idstringOptional

Client will be moved to this partner id.

Example: exnewPA

migrated_channelsstring[]Optional

List of channel ids that will be migrated to target partner.

Example: ["abOd1CH","oe78HsCH"]

created_atstringOptional

Datetime of when this PCR was created.

Example: 2023-01-02T12:00:00Z

modified_atstringOptional

Datetime of when this PCR was updated.

Example: 2023-01-04T12:00:00Z

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/selective_partner_change_requests/{pcr_id}/approve

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/selective_partner_change_requests/{pcr_id}/approve HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "examplePCR",
  "status": "completed",
  "is_full_migration": true,
  "source_client_id": "exampleCL",
  "target_client_id": "exnewCL",
  "source_partner_id": "exoldPA",
  "target_partner_id": "exnewPA",
  "migrated_channels": [
    "abOd1CH",
    "oe78HsCH"
  ],
  "created_at": "2023-01-02T12:00:00Z",
  "modified_at": "2023-01-04T12:00:00Z"
}