Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).

Body

application/json
name
string
required

session name, trimmed.

Required string length: 1 - 80
start_time
string
required

start of the session as HH:MM in the timezone.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
end_time
string
required

end of the session as HH:MM in the timezone; must differ from start_time.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
timezone
string
default:America/New_York

IANA timezone the clocks are read in.

Required string length: 1 - 80
id
string | null

id of the custom session to update; omit to create one.

Required string length: 1 - 80

Response

Successful Response

status
string
required

updated or unchanged.

session
CustomSession · object
required

the saved session.

custom_sessions
CustomSession · object[]
required

every custom session after this write.

changed
SessionsChanged · object
required

what this write changed.