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
string | null
Markdown-supported description shown on the public booking page
integer
Range1 <= value <= 20
integer
Range5 <= value <= 240
integer
Range5 <= value <= 240
integer
Range1 <= value <= 5
string | null
Earliest appointment date. Canonical format: YYYY-MM-DD
FormatdateLengthlength <= 10
string | null
Latest appointment date. Canonical format: YYYY-MM-DD
FormatdateLengthlength <= 10
integer | null
Range-9007199254740991 <= value <= 9007199254740991
string
Value in"timezone" | "zipcode"
string
Value in"phone_call" | "in_person" | "video_call" | "agent_phone_call"
boolean
string
Value in"customer_agent" | "routing_config" | "external_transfer"
string | null
Legacy routing mirror for routing_config assignments. Prefer transferConfigId.
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
string | null
Canonical transfer destination for routing_config and external_transfer assignments
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
array<object>
string
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
boolean
object
string
Value in"event_starts" | "event_ends"
integer
Range-9007199254740991 <= value <= 9007199254740991
object | object
string | null
object
array<object>
integer
Range0 <= value <= 23
integer
Range0 <= value <= 24
array<integer>
Items1 <= items
integer
Range0 <= value <= 59
integer
Range0 <= value <= 59
Response Body
application/json
application/json
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": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"description": "string",
"concurrentLimit": -2147483648,
"appointmentLength": -2147483648,
"appointmentSpacing": -2147483648,
"maxOptions": -2147483648,
"minDate": "2019-08-24",
"maxDate": "2019-08-24",
"minHours": -2147483648,
"preferredMode": "timezone",
"appointmentMode": "phone_call",
"showCallerIdOnBookingPage": true,
"assignmentMode": "customer_agent",
"routingConfigId": "b6e138dd-eba1-4cd6-85c1-31882f4d70e7",
"transferConfigId": "e0ca1204-c276-46be-8cf8-5259ed04eb66",
"workflows": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"enabled": true,
"trigger": {
"anchor": "event_starts",
"offsetMinutes": -9007199254740991
},
"condition": {
"kind": "appointment_status",
"statuses": [
"scheduled"
]
},
"action": {
"type": "sms",
"senderId": "string",
"template": "string"
}
}
],
"bookingHours": [
{
"startHour": 23,
"startMinute": 59,
"endHour": 24,
"endMinute": 59,
"dayOfWeek": [
6
]
}
],
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"readiness": {
"ready": true,
"issues": [
{
"section": "string",
"message": "string"
}
]
},
"assignedCampaignCount": 0,
"assignedTransferConfigCount": 0,
"usedByCampaigns": [
{
"id": "string",
"name": "string",
"kind": "string",
"status": "string"
}
],
"usedByTransferConfigs": [
{
"id": "string",
"name": "string"
}
],
"usedByReceptionist": true
}
}{
"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"
}
],
"failedRecords": [
{
"index": 0,
"phoneNumber": "string",
"firstName": "string",
"lastName": "string",
"externalId": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}