Skip to main content
Create Disposition Group
curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/dispositions/groups/create \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "dispositions": [
    {}
  ]
}
'
{
  "success": true,
  "message": "Disposition group created successfully",
  "data": {
    "id": "BQhJQMcijOPZEVhXgova",
    "name": "Call Back",
    "description": "Call customer again if given dispositions are found",
    "dispositions": [
      "qmJFQyVugpOAPjREQeEF",
      "sorlyJWVWKvqzfPFFeuT"
    ],
    "createdAt": "2024-11-19T12:32:10",
    "updatedAt": "2024-11-19T12:32:10"
  }
}

​
Overview

Create a new group to organize dispositions for specific actions like callbacks or follow-ups.

​
Headers

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

​
Request Body

​
name
string
required
Group name (max 100 characters)
​
description
string
Group description (max 1000 characters)
​
dispositions
array
Array of disposition IDs to include in the group (max 100 items)

​
Response

​
success
boolean
Indicates if the request was successful
​
message
string
Response message
​
data
object
Created disposition group object
{
  "success": true,
  "message": "Disposition group created successfully",
  "data": {
    "id": "BQhJQMcijOPZEVhXgova",
    "name": "Call Back",
    "description": "Call customer again if given dispositions are found",
    "dispositions": [
      "qmJFQyVugpOAPjREQeEF",
      "sorlyJWVWKvqzfPFFeuT"
    ],
    "createdAt": "2024-11-19T12:32:10",
    "updatedAt": "2024-11-19T12:32:10"
  }
}

​
Error Codes

StatusDescription
400Validation error or invalid disposition IDs
401Unauthorized - Invalid or missing API key
403Forbidden - Missing required permissions
409A group with this name already exists
500Internal server error

​
Notes

  • Duplicate disposition IDs in the array are automatically removed
  • All disposition IDs must belong to your organization
  • You can create an empty group (no dispositions) and add them later