Edit event

Edit a single event's fields

Path Parameters

companyID companyID required

The id of the company

eventID eventID required

The id of the event

application/json

Request Body

Event fields to update

title string

Title of the event

type string

Type of the event

description string

Description of the event (in HTML)

location string

Possible values: [IN_PERSON, ONLINE, HYBRID]

Location of the event

startTime date-time

Start time of the event (UTC)

endTime date-time

End time of the event (UTC)

timeZone string

Time zone of the event

capacity integer nullable

Capacity of the event

callUrl string nullable

Call URL of the event

code string nullable

Analytics code for admins

address object nullable

Address of the event

main string

Main text

secondary string

Secondary text

formattedAddress string nullable

Formatted address

audience object
Audience target of the event
inviteOnly boolean
Whether the event is invite only
filters object[]
List of filters to target the audience
Array [
key string
Key of the filter
value string
Value of the filter
]
surveys object

Survey settings for the event

pre object nullable

Pre-event survey settings

id string

ID of the survey template

anonymous boolean

Whether the survey is anonymous

editable boolean

Whether the survey is editable by participants

limitDate date-time nullable

Deadline for submitting survey responses

notifications object

slack boolean

Whether to send a Slack notification

email boolean

Whether to send an email notification

post object nullable

Post-event survey settings

id string

ID of the survey template

anonymous boolean

Whether the survey is anonymous

editable boolean

Whether the survey is editable by participants

limitDate date-time nullable

Deadline for submitting survey responses

notifications object

slack boolean

Whether to send a Slack notification

email boolean

Whether to send an email notification

Responses

• 200
• 400
• 404

---

Event updated successfully

application/json

Schema

Example (from schema)

---

Schema

id string

Unique ID of the event

createdAt date-time

Date the event was created

updatedAt date-time

Date the event was last updated

title string

Title of the event

type string

Type of the event

code string nullable

Analytics code for admins

description string

Description of the event (in HTML)

location string

Possible values: [IN_PERSON, ONLINE, HYBRID]

Location of the event

startTime date-time

Start time of the event (UTC)

endTime date-time

End time of the event (UTC)

timeZone string

Time zone of the event

capacity integer nullable

Capacity of the event

organizers string[]

List of organizers of the event

audience object
Audience target of the event
inviteOnly boolean
Whether the event is invite only
filters object[]
List of filters to target the audience
Array [
key string
Key of the filter
value string
Value of the filter
]
participants string[]

List of participants of the event

waitlist string[]

List of users on the waitlist

declined string[]

List of users who declined the event

callUrl string nullable

Call URL of the event

address object nullable

Address of the event

main string

Main text

secondary string

Secondary text

formattedAddress string nullable

Formatted address

calendar object nullable

Calendar details of the event

google object nullable

Google Calendar details

id string

Unique ID of the event in Google Calendar

meetingRoomEmails string[] nullable

List of meeting room added to the calendar event

microsoft object nullable

Microsoft Outlook details

id string

Unique ID of the event in Microsoft Outlook

meetingRoomEmails string[] nullable

List of meeting room added to the calendar event

link string

Link to the event

{
  "id": "2020-01-01:2e8f9915-fda0-450c-95a3-d61f93c66fa9",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "title": "Team lunch",
  "type": "lunch",
  "code": "string",
  "description": "Lunch with <b>all</b> the team",
  "location": "IN_PERSON",
  "startTime": "2021-01-01T00:00:00.000Z",
  "endTime": "2021-01-01T00:00:00.000Z",
  "timeZone": "America/New_York",
  "capacity": 10,
  "organizers": [
    "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
  ],
  "audience": {
    "inviteOnly": true,
    "filters": [
      {
        "key": "team",
        "value": "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
      }
    ]
  },
  "participants": [
    "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
  ],
  "waitlist": [
    "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
  ],
  "declined": [
    "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
  ],
  "callUrl": "https://meet.google.com/abc-123",
  "address": {
    "main": "San Francisco",
    "secondary": "California",
    "formattedAddress": "San Francisco, California, United States"
  },
  "calendar": {
    "google": {
      "id": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
      "meetingRoomEmails": [
        "xxx@resource.calendar.google.com"
      ]
    },
    "microsoft": {
      "id": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
      "meetingRoomEmails": [
        "room@yourdomain.com"
      ]
    }
  },
  "link": "https://app.at.cafe/events/2021-01-01/2e8f9915-fda0-450c-95a3-d61f93c66fa9"
}

An error when a parameter is missing or invalid

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

An error when the event is not found

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

Loading...