Skip to main content
PATCH
/
appointments
/
{appointmentId}
Patch an appointment
curl --request PATCH \
  --url https://api.guile.app/appointments/{appointmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '
{
  "givenName": "<string>",
  "surname": "<string>",
  "barber": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "givenName": "<string>",
    "surname": "<string>",
    "preferredName": "<string>"
  },
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "shopName": "<string>"
  },
  "services": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "cost": "456.78",
      "duration": "<string>"
    }
  ],
  "occursOn": "2023-11-07T05:31:56Z",
  "duration": "<string>",
  "cost": "456.78"
}
'
{
  "givenName": "<string>",
  "barber": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "givenName": "<string>",
    "surname": "<string>",
    "preferredName": "<string>"
  },
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "shopName": "<string>"
  },
  "services": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "cost": "456.78",
      "duration": "<string>"
    }
  ],
  "occursOn": "2023-11-07T05:31:56Z",
  "duration": "<string>",
  "cost": "456.78",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "state": "pending",
  "paymentState": "pending",
  "totalAuthorized": "456.78",
  "totalCaptured": "456.78",
  "totalRefunded": "456.78",
  "surname": "<string>",
  "cancelationFeeType": "lateCancelation"
}

Path Parameters

​
appointmentId
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Body

application/merge-patch+json
​
givenName
string<text> | null

The given name of the customer.

Required string length: 1 - 55
​
surname
string<text> | null

The surname of the customer, if known.

Required string length: 1 - 55
​
barber
object

The barber for this appointment. A reference to a barber resource. This contains a subset of properties for the barber. Use Barber for the full resource entity.

​
location
object

The location for this appointment. A reference to a shop location. This contains a subset of properties for the location. Use ShopLocation for the full resource entity.

​
services
object[] | null

The services for this appointment.

​
occursOn
string<date-time> | null

The date and time the appointment occurs on. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone.

​
duration
string<duration> | null

The duration of the appointment. The value is an ISO 8601 duration string.

For example, an appointment lasting 30 minutes would be represented as PT30M.

​
cost
string<decimal>

The cost of the appointment, excluding any tips, fees or taxes. A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision.

Example:

"456.78"

Response

Ok. The operation succeeded.

A representation of an appointment.

​
givenName
string<text>
required

The given name of the customer.

Required string length: 1 - 55
​
barber
object
required

The barber for this appointment.

​
location
object
required

The location for this appointment.

​
services
object[]
required

The services for this appointment.

​
occursOn
string<date-time>
required

The date and time the appointment occurs on. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone.

​
duration
string<duration>
required

The duration of the appointment. The value is an ISO 8601 duration string.

For example, an appointment lasting 30 minutes would be represented as PT30M.

​
cost
string<decimal>
required

The cost of the appointment, excluding any tips, fees or taxes.

Example:

"456.78"

​
id
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

​
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
state
enum<string>
required

The appointment state. This is derived and immutable.

Available options:
pending,
scheduled,
canceled,
completed
​
paymentState
enum<string>
required

The state state of the appointment. This is derived and immutable.

Available options:
pending,
authorized,
paid,
failed
​
totalAuthorized
string<decimal>
required

The sum amount of authorized payments for this appointment.

Example:

"456.78"

​
totalCaptured
string<decimal>
required

The sum amount of captured payments for this appointment.

Example:

"456.78"

​
totalRefunded
string<decimal>
required

The sum amount of refunded payments for this appointment.

Example:

"456.78"

​
surname
string<text>

The surname of the customer, if known.

Required string length: 1 - 55
​
cancelationFeeType
enum<string>

If included, the type of cancelation fee incurred. This is derived and immutable.

Available options:
lateCancelation,
noShow