Skip to main content
Create Disposition
curl --request POST \
  --url https://api.agents.timepay.ai/api/v1/dispositions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "priority": 123
}
'
{
  "success": true,
  "message": "Disposition created successfully",
  "data": {
    "id": "NiciJNJoGytGUGiyhqgK",
    "name": "Pay in Coming Days/Weeks",
    "description": "Mark if customer says they will pay next day or after few days.",
    "priority": 0,
    "createdAt": "2025-02-06T09:02:03",
    "updatedAt": "2025-02-06T09:02:03"
  }
}

Overview

Create a new disposition to classify call outcomes in your campaigns.

Headers

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

Request Body

name
string
required
Disposition name (max 100 characters)
description
string
Detailed description of when to use this disposition (max 1000 characters)
priority
integer
default:"500"
Priority level from 0-1000 (0 = highest priority)

Response

success
boolean
Indicates if the request was successful
message
string
Response message
data
object
Created disposition object
{
  "success": true,
  "message": "Disposition created successfully",
  "data": {
    "id": "NiciJNJoGytGUGiyhqgK",
    "name": "Pay in Coming Days/Weeks",
    "description": "Mark if customer says they will pay next day or after few days.",
    "priority": 0,
    "createdAt": "2025-02-06T09:02:03",
    "updatedAt": "2025-02-06T09:02:03"
  }
}

Error Codes

StatusDescription
400Validation error - check the errors array for details
401Unauthorized - Invalid or missing API key
403Forbidden - Missing required permissions
409A disposition with this name already exists
500Internal server error