Skip to main content
POST
/
api
/
v1
/
vendors
/
{vendorId}
/
organizations
/
{organizationId}
/
agents
/
{agentId}
/
tasks
Create Agent Task
curl --request POST \
  --url https://app.deepslate.eu/api/v1/vendors/{vendorId}/organizations/{organizationId}/agents/{agentId}/tasks \
  --header 'Content-Type: application/json' \
  --data '
{
  "userValues": {
    "customer_name": "Alice Wonderland",
    "product_interest": "Teapot",
    "callback_reason": "Price query"
  },
  "targetNumber": "+491721234567",
  "allowedHoursBegin": 9,
  "allowedHours": 8,
  "onlyWeekdays": true,
  "execute": true
}
'
{
  "success": true,
  "timestamp": "2025-04-17T14:23:30Z",
  "message": "<string>",
  "data": {
    "id": "77aaddcc-88bb-11ee-aacc-112233445566",
    "userValues": {
      "customer_name": "Alice Wonderland",
      "product_interest": "Teapot",
      "callback_reason": "Price query"
    },
    "targetNumber": "+491721234567",
    "status": "SCHEDULED",
    "onlyWeekdays": true,
    "createdAt": "2024-02-01T09:15:30Z",
    "allowedHoursBegin": 9,
    "allowedHours": 8,
    "conclusionId": "<string>"
  },
  "traceId": "<string>"
}

Path Parameters

​
vendorId
string
required

ID of the Vendor (UUID)

​
organizationId
string
required

ID of the Organization (UUID)

​
agentId
string
required

ID of the Agent (UUID)

Body

application/json

Agent task create data

​
userValues
object
required

Key-value pairs representing user-specific data relevant to the task.

Example:
{
  "customer_name": "Alice Wonderland",
  "product_interest": "Teapot",
  "callback_reason": "Price query"
}
​
targetNumber
string
required

Target phone number for the task (e.g., customer callback number, preferably E.164 format).

Example:

"+491721234567"

​
allowedHoursBegin
integer<int32>

Start hour (0-23) of the allowed execution window in UTC. Null means no restriction.

Example:

9

​
allowedHours
integer<int32>

Length of the allowed execution window in hours. Null means no restriction.

Example:

8

​
onlyWeekdays
boolean

When true, only schedule calls on weekdays (Mon-Fri).

Example:

true

​
execute
boolean

When true, schedule the task for execution.

Example:

true

Response

Agent task created successfully

Standard API response wrapper

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
timestamp
string<date-time>
required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

​
message
string

Human-readable message

​
data
object

Payload data object

​
traceId
string

Correlation or trace ID