Skip to content
/
Update Event

Update Event

Request

Replace the mutable properties of an Event.

Security
BearerPartnerUser
Path
location_idinteger, >= 1required

Location ID

event_idinteger, >= 1required

Event ID

Query
includeArray of strings, unique(Event Includes)

Related resources to include in the updated Event

Items Enum:"staff""service""resource_instances""labels""duration_details""master"
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
team_member_idinteger, >= 1required

Team Member ID

service_idinteger, >= 1required

Service ID

resource_instance_idsArray of integersrequired

Resource Instance IDs; an empty array is allowed

label_idsArray of integersrequired

Tag IDs; an empty array is allowed

datestring^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}...required

Event start in the Location timezone as YYYY-MM-DD HH:MM:SS

lengthinteger, multiple of 300, [ 1 .. 86400 ]required

Total Event duration in seconds, including any technical break

capacityinteger, >= 1required

Total number of available places

technical_break_durationinteger or null, multiple of 300, [ 0 .. 3600 ]

Technical break in seconds; null keeps or derives the current value

commentstring or null, [ 1 .. 255 ] characters

Event comment

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

Event color including #

instructionsstring or null, [ 1 .. 500 ] characters

Instructions for Booking Users

forceboolean

Skip Team Member and Resource Instance availability conflicts

Default:false
curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/locations/{location_id}/events/{event_id}?include=staff' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "team_member_id": 1,
    "service_id": 1,
    "resource_instance_ids": [
      1
    ],
    "label_ids": [
      1
    ],
    "date": "string",
    "length": 1,
    "technical_break_duration": 0,
    "capacity": 1,
    "comment": "string",
    "color": "string",
    "instructions": "string",
    "stream_link": "string",
    "force": false
  }'

Responses

Event updated successfully

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

Empty JSON array returned for an Event item

includedArray of objects(includedResource)

Resources requested through include, when available

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