Create Event Chain

post

https://{api_url}/api/v5/admin/{company_id}/event_chains

Creates a new event chain.
Event chains are either single events, regularly occurring events or are courses.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company ID

Body Params

name

string

required

description

string

long_description

string

spaces

int32

Defaults to 10

resource_id

int32

detail_group_id

int32

event_group_id

int32

global_event_group_id

int32

person_id

int32

duration

int32

Defaults to 60

datetime

date-time

Date and time in ISO-8601 (YYYY-MM-DD hh:mm), in increments of five minutes

time

date-time

Time in ISO-8601 (YYYY-MM-DD hh:mm), in increments of five minutes

start_date

date-time

Start date of the event chain

end_date

date-time

End date of the event chain

price

int32

ticket_type

string

Defaults to multi_space

address_id

int32

reference

string

Your reference id for the event chain

max_num_bookings

int32

Maximum number of bookings per transaction

min_advance

string

Minimum advance time for accepting the bookings

max_advance

string

Maximum advance time for accepting the bookings

min_cancel

string

Minimum duration of time for before booking cancelations are close

repeat

int32

enum

Defaults to 6

The repeat type of event chain.
Values:
None: 0
Week: 1
Fortnight: 2
Weekday: 3
Weekend: 4
Daily: 5
Custom: 6
Monthly day: 7

events[datetime]

array of date-times

Date and time of the event in ISO-8601 (YYYY-MM-DD hh:mm)

events[datetime]

events[duration]

array of int32s

Duration of the event

events[duration]

disabled

boolean

Disable this event chain without deleting it

validate_availability

boolean

Validate that the staff member AND resource is available

type

int32

enum

Defaults to 3

The type of event chain, default: SLOT.
Values:
Event: 0
Recurring: 2
Slot: 3

Allowed:

copy_to_children

boolean

Auto-copy to all child companies (parent companies only)

template

boolean

Mark this event chain as a template

person_ids

array of int32s

Additional staff IDs to block during this event

person_ids

resource_ids

array of int32s

Additional resource IDs to block during this event

resource_ids

custom_times

array of int32s

Additional start times as minutes-from-midnight, max 25 entries (e.g. [540, 600] for 09:00, 10:00)

custom_times

custom_dates

array of strings

Specific dates (YYYY-MM-DD) for a 'specific days' (repeat = 6) event chain. start_date/end_date are derived from these.

custom_dates

is_private

boolean

If true, the event will not show up in the public event lists

invitation_only

boolean

Invitation only for private events (requires is_private)

capacity_view

int32

How to display available spaces

limit_by_email

boolean

Limit max tickets by email

deposit_type

int32

Deposit type

deposit

double

Deposit amount

waitlength

int32

Maximum wait list size

allow_pdf

boolean

Allow PDF tickets

pdf_ticket_id

int32

PDF ticket template ID

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Event Chain