v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

BookingCustomAttributes

UpsertBookingCustomAttribute

Upserts a bookings custom attribute.

To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope. To call this endpoint with seller-level permissions, set APPOINTMENTS_ALL_WRITE and APPOINTMENTS_WRITE for the OAuth scope.

For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to Appointments Plus or Appointments Premium.

put/v2/bookings/{booking_id}/custom-attributes/{key}

Path parameters

booking_idstring required

The ID of the target booking.

keystring required

The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

Request body

idempotency_keystring nullable

A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Response

Success

Example response

{
  "custom_attribute": {
    "created_at": "2022-11-16T15:50:27Z",
    "key": "favoriteShampoo",
    "updated_at": "2022-11-16T15:50:27Z",
    "value": "Spring Fresh",
    "version": 1,
    "visibility": "VISIBILITY_READ_ONLY"
  },
  "errors": []
}