Cancel an appointment

POST

/api/v1/appointments/{id}/cancel

curl --request POST \
  --url https://digize.com/api/v1/appointments/example/cancel \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "reason": "example", "refund": true }'

• Digize

Cancels an appointment, emails the customer and gives its time back. A paid deposit is refunded unless refund is false.

Needs the crm:write permission. It can’t be undone.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

reason

Any of:

string

string

<= 500 characters

null

null

refund

boolean

Example ^generated

{
  "reason": "example",
  "refund": true
}

Responses

200

Done

Media typeapplication/json

object

id

required

string

calendarId

required

string

service

required

The calendar’s name when it was booked.

string

customer

required

object

id

required

The contact’s id.

string

name

required

string

email

required

string

phone

required

string

staff

required

object

id

required

The team member’s user id.

string

name

required

string

partySize

required

number

startsAt

required

string format: date-time

endsAt

required

string format: date-time

status

required

string

Allowed values: confirmed deposit_due completed cancelled no_show

total

required

The price for the whole party.

integer

<= 100000000

deposit

required

The deposit for the whole party.

integer

<= 100000000

depositPaidAt

required

Any of:

string

string format: date-time

null

null

depositRefunded

required

boolean

paymentId

required

The Stripe PaymentIntent that took the deposit.

string | null

notes

required

string | null

bookedVia

required

string

Allowed values: site staff

bookedAt

required

string format: date-time

refunded

required

Whether the deposit was refunded now.

boolean

Example

{
  "status": "confirmed",
  "bookedVia": "site"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}