Skip to main content
Update Disposition Group
curl --request PUT \
  --url https://api.agents.timepay.ai/api/v1/dispositions/groups/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "dispositions": [
    {}
  ]
}
'
{
  "success": true,
  "message": "Disposition group updated successfully",
  "updatedFields": ["name", "dispositions"]
}

Overview

Update an existing disposition group. Only the fields you provide will be updated; all other fields remain unchanged.
When updating the dispositions array, the entire array is replaced. Use the Add Dispositions or Remove Dispositions endpoints for incremental changes.

Headers

Authorization
string
required
Bearer token for authentication (e.g., Bearer <your_token>).

Path Parameters

id
string
required
The unique identifier of the disposition group to update

Request Body

name
string
Group name (max 100 characters)
description
string
Group description (max 1000 characters)
dispositions
array
Array of disposition IDs (replaces existing list)

Response

success
boolean
Indicates if the request was successful
message
string
Response message
updatedFields
array
List of fields that were updated
{
  "success": true,
  "message": "Disposition group updated successfully",
  "updatedFields": ["name", "dispositions"]
}

Error Codes

StatusDescription
400Validation error, no valid fields, or invalid disposition IDs
401Unauthorized - Invalid or missing API key
403Forbidden - Missing required permissions
404Disposition group not found
409A group with this name already exists
500Internal server error