Change customer of a case

Overview

Use this API to change the customer of a single case. For this API to execute successfully:

  • The Case ID must exist in the application.
  • The status of the case must be 'open'.
  • Source and target customer of the case must be different.
  • If "Customer departmentalization" setting is enabled in the application, source and target customer of the case must belong to the same department.

Permissions

All of the following are required:

  • Must have 'Change Customer' action on 'Customer' resource.
  • The case must either belong to the user's home department, or to a department in which the user is a foreign user.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ids
required
string <= 20000 characters

Pass one id or comma sperated list of id(s).

Examples:
Providing single ID.
1001
Providing multiple IDs.
1001,1002
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json

Elements required in request body

Name Description
case.customer.id ID of the target customer.
required
object (customer)

Customer associated with the case (ID, name and self-link).

lastClosed
string <date-time> (lastClosed)

Last closed date of the closed case.

Responses
204

Success

400

Bad Request message

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

patch/case/{ids}/changecustomer
Request samples
application/json
  • PATCH /core/casemgr/v3/case/1001/changecustomer
  • This example demonstrates the following:
    • Changing the customer of a case.
{
  • "customer": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}