CampaignsAppointment configs
Create appointment config
Create a new appointment config
Authorization
x-api-key x-api-key<token>
API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Request Body
application/json
POST /v2/campaigns/appointment-configs Request body
TypeScript Definitions
Use the request body type in TypeScript.
string
Appointment config name
Length1 <= length
integer
Range-9007199254740991 <= value <= 9007199254740991
integer
Range-9007199254740991 <= value <= 9007199254740991
integer
Range-9007199254740991 <= value <= 9007199254740991
integer
Range-9007199254740991 <= value <= 9007199254740991
string | null
Lengthlength <= 10
string | null
Lengthlength <= 10
integer | null
Range-9007199254740991 <= value <= 9007199254740991
string
Value in"timezone" | "zipcode"
string | null
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.carecycle.ai/v2/campaigns/appointment-configs" \ -H "Content-Type: application/json" \ -d '{}'{
"appointmentConfig": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": null,
"updatedAt": null,
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"concurrentLimit": -2147483648,
"appointmentLength": -2147483648,
"appointmentSpacing": -2147483648,
"maxOptions": -2147483648,
"minDate": "string",
"maxDate": "string",
"minHours": -2147483648,
"preferredMode": "timezone",
"pulseWorkflowId": "6cbf4411-f62a-452f-b47e-a87913280a83",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "VALIDATION_ERROR",
"errors": [
{
"path": [
"string"
],
"message": "string",
"expected": "string",
"received": "string",
"code": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}