Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Events

Create a new event.

Create a new event.

Required scopes: flex.collaboration.events.create

post/api/v2/organizations/{orgSlug}/events

Path parameters

orgSlugstring required

organization slug

Request body

titlestring required

The title of the event.

locationstring required

The location of the event.

startstring required

The start date of the event.

endstring required

The end date of the event.

linksstring[]

An array containing all the links associated with the events.

descriptionstring

The description of the event.

wherestring

A description of where the event will be taking place.

limitnumber

The number of participants that this event will host.

companystring

The _id of the company that will be associated with the event.

imagestring

The image link associated with the event.

timezonestring

The timezone of the event.

Example request

{
  "title": "Lunch and Learn",
  "location": "603dfbc260f4054084125d33",
  "start": "2024-01-01T06:00:00Z",
  "end": "2024-01-01T12:00:00Z",
  "links": [
    "https://www.google.com",
    "https://app.officernd.com"
  ],
  "description": "Join us for a lunch and learn session.",
  "where": "Conference Room 1",
  "limit": 20,
  "company": "603dfbc260f4054084125d33",
  "image": "https://www.google.com/image.png",
  "timezone": "America/New_York"
}

Response

_idstring

The _id of the event.

startstring

The start date of the event.

endstring

The end date of the event.

timezonestring

The timezone of the event.

titlestring

The title of the event.

locationstring

The _id of the location of the event.

locationsstring[]

The ids of the locations where the event is visible.

descriptionstring

The description of the event.

wherestring

A description of where the event will be taking place.

companystring

The _id of the company that will be associated with the event.

memberstring

The _id of the member who created the event.

limitnumber

The number of participants that this event will host.

linksstring[]

An array containing all the links associated with the events.

imagestring

The image link associated with the event.

Example response

{
  "_id": "603dfbc260f4054084125d30",
  "start": "2024-01-01T06:00:00Z",
  "end": "2024-01-01T12:00:00Z",
  "timezone": "America/New_York",
  "title": "Lunch and Learn",
  "location": "603dfbc260f4054084125d33",
  "locations": [
    "603dfbc260f4054084125d33",
    "603dfbc260f4054084125d34"
  ],
  "description": "Join us for a lunch and learn session.",
  "where": "Conference Room 1",
  "company": "603dfbc260f4054084125d33",
  "member": "603dfbc260f4054084125d33",
  "limit": 20,
  "links": [
    "https://www.google.com",
    "https://app.officernd.com"
  ],
  "image": "https://www.google.com/image.png"
}