Create event

Create a new event in a community feed.

Event Types:

• virtual: Online event (can have external URL or livestream)
• in_person: Physical event (requires location)

Important Notes:

• Start time must be in the future
• End time must be after start time
• Location is required for in-person events
• Only community members can create events in a community

POST /api/v1/events

Create event

cURL

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

200

{
  "events": [
    {
      "eventId": "<string>",
      "userId": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "publisherId": "<string>",
      "publisherInternalId": "<string>",
      "publisherPublicId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "location": "<string>",
      "externalUrl": "<string>",
      "coverImageFileId": "<string>",
      "originId": "<string>",
      "discussionCommunityId": "<string>",
      "postId": "<string>",
      "path": "<string>",
      "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
    }
  ],
  "posts": [
    {
      "postId": "<string>",
      "data": {
        "title": "<string>",
        "text": "<string>",
        "fileId": "<string>",
        "thumbnailFileId": "<string>",
        "videoFileId": {
          "original": "<string>",
          "low": "<string>",
          "medium": "<string>",
          "high": "<string>"
        },
        "streamId": "<string>"
      },
      "_id": "<string>",
      "path": "<string>",
      "parentPostId": "<string>",
      "postedUserId": "<string>",
      "postedUserPublicId": "<string>",
      "postedUserInternalId": "<string>",
      "sharedUserId": "<string>",
      "sharedCount": 123,
      "targetId": "<string>",
      "targetPublicId": "<string>",
      "targetInternalId": "<string>",
      "dataType": "text",
      "metadata": {},
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "editedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "reactions": {
        "like": 1
      },
      "reactionsCount": 1,
      "myReactions": [
        "like"
      ],
      "commentsCount": 1,
      "comments": [
        "<string>"
      ],
      "children": [
        "<string>"
      ],
      "childrenNumber": 123,
      "isDeleted": false,
      "hasFlaggedComment": false,
      "hasFlaggedChildren": false,
      "feedId": "<string>",
      "tags": [
        "<string>"
      ],
      "hashtags": [
        "technology",
        "programming",
        "web_development",
        "JavaScript",
        "AI_trends"
      ],
      "mentionees": [
        {
          "type": "user",
          "userIds": [
            "<string>"
          ],
          "userPublicIds": [
            "<string>"
          ],
          "userInternalIds": [
            "<string>"
          ]
        }
      ],
      "impression": 123,
      "reach": 123,
      "structureType": "text"
    }
  ],
  "rooms": [
    {
      "_id": "<string>",
      "targetId": "<string>",
      "referenceType": "post",
      "referenceId": "<string>",
      "liveChannelId": "<string>",
      "liveChatEnabled": true,
      "title": "<string>",
      "roomId": "<string>",
      "description": "<string>",
      "thumbnailFileId": "<string>",
      "participants": [
        {
          "userId": "<string>",
          "userInternalId": "64be1f6cb9b4106b5a6bbf3f"
        }
      ],
      "livePlaybackUrl": "https://stream.example.com/someid.m3u8?token=token",
      "liveThumbnailUrl": "https://image.example.com/someid/thumbnail.png?token=token",
      "recordedPlaybackInfos": [
        {
          "url": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch",
          "thumbnailUrl": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"
        }
      ],
      "durationSeconds": 123,
      "moderation": {
        "flagLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "terminateLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "parentRoomId": "<string>",
      "childRoomIds": [],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "creatorInternalId": "64be1f6cb9b4106b5a6bbf3f",
      "updatedAt": "2023-11-07T05:31:56Z",
      "liveAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "isDeleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "<string>",
      "path": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

title · string · required

Required string length: 1 - 60

type · enum<string> · required

Available options: virtual, in_person

startTime · string<date-time> · required

endTime · string<date-time> · required

originType · enum<string> · default: community · required

Available options: community, user

originId · string · required

description · string

Maximum string length: 1000

streamType · enum<string> · default: coHosts

Livestream type for virtual events

Available options: directStreaming, coHosts

location · string

Maximum string length: 200

externalUrl · string

coverImageFileId · string

tags · string[]

Maximum array length: 5

Maximum string length: 100

isLocationVisible · boolean · default: true

liveChatEnabled · boolean · default: true

Enable live chat on the livestream of a virtual event

metadata · object

Response

200

application/json

Event created successfully

events · object[]

Show child attributes

users · object[]

Show child attributes

files · object[]

Show child attributes

communities · object[]

Show child attributes

posts · object[]

Show child attributes

rooms · object[]

Show child attributes