Update Orchestration

Overview

Use this API to update existing orchestration configuration.

Scope

Client application must have 'app.conversation.conversationmgr.manage' scope assigned.

SecurityoAuthClient

Request

path Parameters

required

string = 36 characters

id of object

Example: 7b6c5fff-036e-4a40-b68a-a67c592fc079

Request Body schema: application/json

Update orchestration

name required	string Name for orchestration
description	string [ 1 .. 1023 ] characters
active	boolean Default: true
required	object
modified	string <date-time> Last modified time in GMT

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/orchestrations/{id}

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"name": "default_orchestration",
"description": "Created for custom channel.",
"active": true,
"modified": "2021-06-11T23:14:41.836Z",
"applications": {"botConfiguration": {"forwardTranscript": true,
"bots": [{"id": "a09dddd6-394b-4039-86bc-a5dd89ee5e8d",
"participant": {"id": "b09dddd6-394b-4039-86bc-a5dd89ee5e8d"
},
"onEscalation": {"agent": {"id": "c09dddd6-394b-4039-86bc-a5dd89ee5e8d"
}
}
}
]
},
"customerConfiguration": {"customer": {"id": "b09dddd6-394b-4039-86bc-a5dd89ee5e8d"
}
}
}
}

Response samples

application/json

Required attribute is missing in payload

{"code": "400-143",
"developerMessage": "Required attribute is missing in the request body: <attribute>"
}