GET /api/v2/corporate-events
List the entity's corporate events


GET /api/v2/corporate-events/:id
Show a corporate event

Params

Param name Description
id
required

corporate event ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/corporate-events
Create a corporate event

Params

Param name Description
data
required

corporate event Information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][title]
required

The title of the event

Validations:

  • Must be a String

data[attributes][start_at]
required

The start of the event

Validations:

  • Must be a DateTime

data[attributes][end_at]
required

The end of the event

Validations:

  • Must be a DateTime

data[attributes][detail]
required

The details of the event

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][entity]
required

Validations:

  • Must be a Hash

data[relationships][entity][data]
required

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
required

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
required

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/corporate-events/:id
Update the corporate event

Params

Param name Description
id
required

corporate event ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

corporate event Information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][title]
optional

The title of the event

Validations:

  • Must be a String

data[attributes][start_at]
optional

The start of the event

Validations:

  • Must be a DateTime

data[attributes][end_at]
optional

The end of the event

Validations:

  • Must be a DateTime

data[attributes][detail]
optional

The details of the event

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
optional

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/corporate-events/:id/book-reservation
Book reservation for the corporate event

Params

Param name Description
id
required

the corporate event ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

corporate event Information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][title]
optional

The title of the event

Validations:

  • Must be a String

data[attributes][start_at]
optional

The start of the event

Validations:

  • Must be a DateTime

data[attributes][end_at]
optional

The end of the event

Validations:

  • Must be a DateTime

data[attributes][detail]
optional

The details of the event

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
optional

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/corporate-events/:id/cancel-reservation
Cancel reservation for the corporate event

Params

Param name Description
id
required

the corporate event ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

corporate event Information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][title]
optional

The title of the event

Validations:

  • Must be a String

data[attributes][start_at]
optional

The start of the event

Validations:

  • Must be a DateTime

data[attributes][end_at]
optional

The end of the event

Validations:

  • Must be a DateTime

data[attributes][detail]
optional

The details of the event

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
optional

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /apiv2/corporate-events/:id
Delete a corporate event

Params

Param name Description
id
required

corporate event ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.