Update event

Update event details. Only the event creator or admin can update.

Important Notes:

• Start time must be in the future
• End time must be after start time
• Can cancel event by setting status to ‘cancelled’
• Cancelling an event will delete all scheduled reminders

PUT /api/v1/events/{eventId}

Update event

cURL

curl --request PUT \
  --url https://apix.us.amity.co/api/v1/events/{eventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "location": "<string>",
  "externalUrl": "<string>",
  "coverImageFileId": "<string>",
  "tags": [
    "<string>"
  ],
  "metadata": {}
}
'

200

{
  "events": [
    {
      "eventId": "<string>",
      "userId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "isInviteOnly": true,
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "location": "<string>",
      "externalUrl": "<string>",
      "coverImageFileId": "<string>",
      "originId": "<string>",
      "livestreamId": "<string>",
      "discussionCommunityId": "<string>",
      "isLocationVisible": true,
      "isOriginPublic": true,
      "rsvpCount": 123,
      "interestedCount": 123,
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "isDeleted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ],
  "communities": [
    {
      "communityId": "<string>",
      "channelId": "<string>",
      "displayName": "<string>",
      "_id": "<string>",
      "path": "<string>",
      "userId": "<string>",
      "userPublicId": "<string>",
      "userInternalId": "<string>",
      "avatarFileId": "<string>",
      "description": "<string>",
      "isOfficial": true,
      "isPublic": true,
      "onlyAdminCanPost": true,
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "postsCount": 123,
      "membersCount": 123,
      "isJoined": true,
      "categoryIds": [
        "<string>"
      ],
      "isDeleted": false,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "hasFlaggedComment": false,
      "hasFlaggedPost": false,
      "needApprovalOnPostCreation": false,
      "moderatorMemberCount": 123,
      "allowCommentInStory": true,
      "isDiscoverable": false,
      "requiresJoinApproval": false
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

eventId · string · required

ID of the event

Body

application/json

title · string

Required string length: 1 - 60

description · string

Maximum string length: 1000

type · enum<string>

Available options: virtual, in_person

startTime · string<date-time>

endTime · string<date-time>

location · string

Maximum string length: 200

externalUrl · string

coverImageFileId · string

tags · string[]

Maximum array length: 5

Maximum string length: 24

status · enum<string>

Available options: cancelled

metadata · object

Response

200

application/json

Event updated successfully

events · object[]

Show child attributes

users · object[]

Show child attributes

files · object[]

Show child attributes

communities · object[]

Show child attributes