Skip to content

Update Orchestration

Request

Overview

Use this API to update existing orchestration configuration.

Scope

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

Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Path
idstring, = 36 charactersrequired

id of object

Example:7b6c5fff-036e-4a40-b68a-a67c592fc079
Bodyapplication/json

Update orchestration

namestringrequired

Name for orchestration

Example:"default_orhchestration"
descriptionstring, [ 1 .. 1023 ] characters
activeboolean
Default:true
applicationsobjectrequired
modifiedstring, (date-time)

Last modified time in GMT

PUT
/orchestrations/{id}
curl -i -X PUT \
  https://api.egain.cloud/conversation/conversationmgr/v3/orchestrations/7b6c5fff-036e-4a40-b68a-a67c592fc079 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
        }
      }
    }
  }'

Responses

No Content

Response
No content