Event schedules

>>>

GET /api/v4/event_schedules
List Event Schedules

Event Schedules associated with your company

Examples

{
  "total_records": integer,
  "page_number": integer,
  "data": [
    {
      "id": integer,
      "event_id": integer,
      "starts_at": datetime,
      "ends_at": datetime,
      "created_at": datetime,
      "updated_at": datetime,
      "starting_time": string,
      "starting_date": string,
      "status": string
    },
    ...
  ]
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
page_number
optional

Page Number

Validations:

  • Must be a Integer
event_id
optional

Event ID

Validations:

  • Must be a Integer
>>>

GET /api/v4/event_schedules/:id
Find Event Schedule

Returns all attributes of a Event Schedule

Errors

Code Description
404 Not Found

Examples

{
  "id": integer,
  "event_id": integer,
  "starts_at": datetime,
  "ends_at": datetime,
  "created_at": datetime,
  "updated_at": datetime,
  "starting_time": string,
  "starting_date": string,
  "status": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Schedule ID

Validations:

  • Must be a Integer
>>>

POST /api/v4/event_schedules
Create Event Schedule

Create an event schedule

Errors

Code Description
422 Unable to process request, see errors in response
404 Event Not Found

Examples

{
  "id": integer,
  "event_id": integer,
  "starts_at": datetime,
  "ends_at": datetime,
  "created_at": datetime,
  "updated_at": datetime,
  "starting_time": string,
  "starting_date": string,
  "status": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
event_id
required

Event ID

Validations:

  • Must be a Integer
starting_date
required

Start Date

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 1:00 PM
starting_time
required

Start Time

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
status
optional

Status

Validations:

  • Must be one of: Active, Cancelled.
>>>

PATCH /api/v4/event_schedules/:id
Update Event Schedule

Update an event schedule

Errors

Code Description
404 Not Found
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "event_id": integer,
  "starts_at": datetime,
  "ends_at": datetime,
  "created_at": datetime,
  "updated_at": datetime,
  "starting_time": string,
  "starting_date": string,
  "status": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Schedule ID

Validations:

  • Must be a Integer
starting_date
required

Start Date

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 1:00 PM
starting_time
required

Start Time

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
status
optional

Status

Validations:

  • Must be one of: Active, Cancelled.