Updates conversation context variables for a specific conversation.

PATCH 
/api/v2/agent/:agentCode/conversation/:conversationId/context

Updates conversation context variables for a specific conversation.

Request

Path Parameters

agentCode stringrequired

The agent code to update context variables for.

conversationId uuidrequired

The ID of the conversation to update context variables for.

Query Parameters

culture string

Use this param to override the culture of the response. Options: - en (default) - es

application/json

Body

The key-value pairs of variables to update.

• Array [

key stringnullable
value nullable

• ]

text/json

Body

The key-value pairs of variables to update.

• Array [

key stringnullable
value nullable

• ]

application/*+json

Body

The key-value pairs of variables to update.

• Array [

key stringnullable
value nullable

• ]

Responses

200

Success

text/plain

Schema

Schema

success boolean
updatedKeys string[]nullable

Example (from schema)

{
  "success": true,
  "updatedKeys": [
    "string"
  ]
}

application/json

Schema

Schema

success boolean
updatedKeys string[]nullable

Example (from schema)

{
  "success": true,
  "updatedKeys": [
    "string"
  ]
}

text/json

Schema

Schema

success boolean
updatedKeys string[]nullable

Example (from schema)

{
  "success": true,
  "updatedKeys": [
    "string"
  ]
}

401

The user is unauthorized or the session expired

403

The user does not have permission

500

There was an unexpected error

Loading...