Events

Update event-level BEO fields

Writes event-level BEO fields only (staff, contacts and per-day overrides have their own endpoints). Omit a key to leave it untouched; pass null to clear a nullable field; unknown keys are ignored. Each write bumps beo_version (a change after a sent release warns the team) and synchronises the calendars. Role permission: data.write.

put/events/{id}/beo

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/events/{id}/beo
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.write)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Request body

setup_type'theatre' | 'classroom' | 'u-shape' | 'boardroom' | 'banquet' | 'cocktail' | 'custom' | 'null' nullable
setup_notesstring nullable
catering_notesstring nullable
dietary_notesstring nullable

Diets and allergies (« Contraintes alimentaires »), one line each with the number of guests, for the whole event.

technical_notesstring nullable
service_notesstring nullable
beo_remarksstring nullable

Free-text "Remarks" section below Technical & Service.

beo_contextstring nullable

One-line context atop the BEO. null or empty = the automatic sentence.

onsite_contact_person_idstring uuid nullable

Address-book person used as the on-site contact; a person of the workspace (400 otherwise).

Example request

{
  "schedule": [
    {
      "time": "19:00",
      "label": "Cocktail"
    }
  ]
}

Response

Updated BEO fields.

successboolean
beoobject

The written fields (schedule, setup_type, the notes, beo_remarks, beo_vendors, beo_context, onsite_contact_person_id) and the new beo_version.

Changes

No recorded changes to this operation across all 1 revision of this API.