Create appointment

curl --request POST \
  --url https://www.carstoragesoftware.com/api/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startAt": "2023-11-07T05:31:56Z",
  "endAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "notes": "<string>",
  "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "appointmentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secondaryCarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recurrenceInterval": 2,
  "recurrenceDaysOfWeek": [
    3
  ],
  "recurrenceDayOfMonth": 16,
  "recurrenceEndDate": "2023-11-07T05:31:56Z",
  "recurrenceCount": 2,
  "recurrenceSeriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    startAt: '2023-11-07T05:31:56Z',
    endAt: '2023-11-07T05:31:56Z',
    title: '<string>',
    notes: '<string>',
    locationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    appointmentTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    optionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    carId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    secondaryCarId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    recurrenceInterval: 2,
    recurrenceDaysOfWeek: [3],
    recurrenceDayOfMonth: 16,
    recurrenceEndDate: '2023-11-07T05:31:56Z',
    recurrenceCount: 2,
    recurrenceSeriesId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    eventTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    eventType: '<string>'
  })
};

fetch('https://www.carstoragesoftware.com/api/v1/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://www.carstoragesoftware.com/api/v1/appointments"

payload = {
    "startAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "notes": "<string>",
    "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "appointmentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "secondaryCarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recurrenceInterval": 2,
    "recurrenceDaysOfWeek": [3],
    "recurrenceDayOfMonth": 16,
    "recurrenceEndDate": "2023-11-07T05:31:56Z",
    "recurrenceCount": 2,
    "recurrenceSeriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventType": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "teamId": "<string>",
    "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "appointmentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "scheduled",
    "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "secondaryCarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "notes": "<string>",
    "recurrenceFrequency": "daily",
    "recurrenceInterval": 123,
    "recurrenceDaysOfWeek": [
      123
    ],
    "recurrenceDayOfMonth": 123,
    "recurrenceEndDate": "2023-11-07T05:31:56Z",
    "recurrenceCount": 123,
    "recurrenceSeriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

POST

api

appointments

Create appointment

curl --request POST \
  --url https://www.carstoragesoftware.com/api/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startAt": "2023-11-07T05:31:56Z",
  "endAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "notes": "<string>",
  "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "appointmentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secondaryCarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recurrenceInterval": 2,
  "recurrenceDaysOfWeek": [
    3
  ],
  "recurrenceDayOfMonth": 16,
  "recurrenceEndDate": "2023-11-07T05:31:56Z",
  "recurrenceCount": 2,
  "recurrenceSeriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    startAt: '2023-11-07T05:31:56Z',
    endAt: '2023-11-07T05:31:56Z',
    title: '<string>',
    notes: '<string>',
    locationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    appointmentTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    optionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    carId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    secondaryCarId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    recurrenceInterval: 2,
    recurrenceDaysOfWeek: [3],
    recurrenceDayOfMonth: 16,
    recurrenceEndDate: '2023-11-07T05:31:56Z',
    recurrenceCount: 2,
    recurrenceSeriesId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    eventTypeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    eventType: '<string>'
  })
};

fetch('https://www.carstoragesoftware.com/api/v1/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://www.carstoragesoftware.com/api/v1/appointments"

payload = {
    "startAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "notes": "<string>",
    "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "appointmentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "secondaryCarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recurrenceInterval": 2,
    "recurrenceDaysOfWeek": [3],
    "recurrenceDayOfMonth": 16,
    "recurrenceEndDate": "2023-11-07T05:31:56Z",
    "recurrenceCount": 2,
    "recurrenceSeriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventType": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "teamId": "<string>",
    "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "appointmentTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "scheduled",
    "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "secondaryCarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startAt": "2023-11-07T05:31:56Z",
    "endAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "notes": "<string>",
    "recurrenceFrequency": "daily",
    "recurrenceInterval": 123,
    "recurrenceDaysOfWeek": [
      123
    ],
    "recurrenceDayOfMonth": 123,
    "recurrenceEndDate": "2023-11-07T05:31:56Z",
    "recurrenceCount": 123,
    "recurrenceSeriesId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Team API key from Settings → Integrations. Use Authorization: Bearer <key> or x-api-key.

Body

application/json

startAt

string<date-time>

required

endAt

string<date-time>

required

title

string | null

notes

string | null

status

enum<string>

Available options:

scheduled,

pending_approval,

accepted,

declined,

checked_in,

in_progress,

completed,

cancelled,

no_show

locationId

string<uuid> | null

appointmentTypeId

string<uuid> | null

optionId

string<uuid> | null

carId

string<uuid> | null

secondaryCarId

string<uuid> | null

customerId

string<uuid> | null

recurrenceFrequency

enum<string> | null

Available options:

daily,

weekly,

biweekly,

monthly,

quarterly,

yearly,

null

recurrenceInterval

integer | null

Required range: x >= 1

recurrenceDaysOfWeek

integer[] | null

Required range: 0 <= x <= 6

recurrenceDayOfMonth

integer | null

Required range: 1 <= x <= 31

recurrenceEndDate

string<date-time> | null

recurrenceCount

integer | null

Required range: x >= 1

recurrenceSeriesId

string<uuid> | null

eventTypeId

string<uuid>

Event type id from GET /event-types. Alternative to appointmentTypeId.

eventType

string

Event type value (e.g. vehicle_pick_up). Alternative to eventTypeId.

Minimum string length: 1

Response

Created.

data

object

required

Show child attributes

⌘I

Get started

Cars

Customers

Contacts

Locations

Parking

Event types

Appointments

Communications

Marketing

Create appointment

Authorizations

Body

Response