v6
latestOpenAPI 3.1.02026-08-047720752.5 KBMeetings
Create a meeting
Creates a new meeting. See here for guidance on avoiding duplicate meetings.
This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.
Required scopes: meeting:read-write, record_permission:read.
post/v2/meetings
Request body
Example request
{
"data": {
"title": "Onboarding Session",
"description": "Getting you up to speed with the platform and answering any questions you have.",
"start": {
"datetime": "2027-11-27T14:00:00Z",
"timezone": "America/New_York"
},
"end": {
"datetime": "2027-11-27T15:00:00Z",
"timezone": "America/New_York"
},
"participants": [
{
"email_address": "person@company.com",
"status": "accepted",
"name": "Simon Mitchell"
}
],
"linked_records": [
{
"object": "people",
"record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}
]
}
}Response
Success
Example response
{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"meeting_id": "cb59ab17-ad15-460c-a126-0715617c0853"
},
"title": "Onboarding Session",
"description": "Getting you up to speed with the platform and answering any questions you have.",
"start": {
"datetime": "2027-11-27T14:00:00.000-04:00",
"timezone": "America/New_York"
},
"end": {
"datetime": "2027-11-27T15:00:00.000-04:00",
"timezone": "America/New_York"
},
"participants": [
{
"status": "accepted",
"email_address": "person@company.com",
"name": "Simon Mitchell"
}
],
"linked_records": [
{
"object_slug": "people",
"object_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
"record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d"
}
],
"created_at": "2023-01-01T15:00:00.000000000Z",
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
}
}