Delete booking custom attribute

DELETE

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

Deletes 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.

Permissions:APPOINTMENTS_WRITE

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

booking_id

string

Required

The ID of the target booking.

Link to section

key

string

Required

The key of the custom attribute to delete. 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.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.