v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

BookingCustomAttributes

UpdateBookingCustomAttributeDefinition

Updates a bookings custom attribute definition.

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/custom-attribute-definitions/{key}

Path parameters

keystring required

The key of the custom attribute definition to update.

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_definition": {
    "created_at": "2022-11-16T15:27:30Z",
    "description": "Update the description as desired.",
    "key": "favoriteShampoo",
    "name": "Favorite shampoo",
    "schema": {
      "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
    },
    "updated_at": "2022-11-16T15:39:38Z",
    "version": 2,
    "visibility": "VISIBILITY_READ_ONLY"
  },
  "errors": []
}