Update Event Chain

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

Updates an existing event chain.
Event chains are either single events, regularly occurring events or are courses.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company ID

int32

required

Body Params

name

string

description

string

long_description

string

spaces

int32

resource_id

int32

event_group_id

int32

global_event_group_id

int32

person_id

int32

duration

int32

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

detail_group_id

int32

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

events[datetime]

array of date-times

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

events[datetime]

events[duration]

array of int32s

Event duration

events[duration]

update_events

string

Defaults to all

If you update the default resource/person/service, do you update all occurances of this event, options are 'all','future','none'

disabled

boolean

Disable this event chain without deleting it

repeat

int32

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

type

int32

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

allow_event_type_change

boolean

Defaults to true

Is change of event type allowed (single -> recurring OR vise-versa)

validate_availability

boolean

Validate that the staff member AND resource is available

Responses

403

Forbidden

404

Not Found

Language

Credentials

URL


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://example.jrni.com/api/v5/admin/company_id/event_chains/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "update_events": "all",
8
  "allow_event_type_change": true
9
}
10
'

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

application/json

200Event Chain