Skip to content

Update Event Appointment

Request

Update pricing, Product Items, Tags, color, comment, or capacity for an Event Appointment.

Security
BearerPartnerUser
Path
location_idinteger, >= 1required

Location ID

event_idinteger, >= 1required

Event ID

record_idinteger, >= 1required

Appointment ID; record_id is the literal wire path parameter

Query
includeArray of strings, unique(Appointment Includes)

Related resources to include in the updated Appointment

Items Enum:"client""client.custom_field_values""staff""services""goods""resource_instances""labels""attendance_service_items""attendance_good_items""attendance_document"
Headers
Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"
Example:application/vnd.api.v2+json
Content-Typestringrequired

Request media type

Value:"application/json"
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
attendance_service_itemobjectrequired
attendance_good_itemsArray of objects

Literal wire field for Appointment Product Items

commentstring or null, <= 255 characters

Appointment comment

label_idsArray of integers or null

Tag IDs

colorstring or null^[0-9a-f]{6}$

Appointment color without #

clients_countinteger or null, >= 1

Number of places reserved by the Appointment

curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/events/{event_id}/appointments/{record_id}?include=client' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "attendance_service_item": {
      "cost_per_unit": 0,
      "discount_percent": 0,
      "manual_cost": 0,
      "is_trial": true
    },
    "attendance_good_items": [
      {
        "id": 1,
        "good_id": 1,
        "unit_id": 1,
        "storage_id": 1,
        "staff_id": 1,
        "operation_unit_type": "sale",
        "number": "string",
        "quantity": 0.001,
        "cost_per_unit": 0,
        "manual_cost": 0,
        "discount_percent": 0,
        "marks": [
          "string"
        ],
        "planned_activation_date": "2019-08-24"
      }
    ],
    "comment": "string",
    "label_ids": [
      1
    ],
    "color": "string",
    "clients_count": 1
  }'

Responses

Event Appointment updated successfully

Bodyapplication/json
dataobject(Appointment Resource)required
metaArray of any, <= 0 itemsrequired

Empty JSON array returned for an Event Appointment item

includedArray of objects(includedResource)

Resources requested through include, when available

Response
{ "data": { "type": "record", "id": "string", "attributes": { … }, "relationships": { … } }, "included": [ { … } ], "meta": [] }