POST api/v3/meeting/{meetingKey}
Update a Meeting (v3). Updates an existing meeting's name, call recording, assigned operators, AI summary configuration and meeting preferences — mirrors Meeting.aspx's edit flow. Authenticate with the API Secret sent as an Authorization header: "Authorization: Bearer <secret>".
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| meetingKey |
The meeting's key (GUID), from the route. Must belong to a meeting in the caller's company. |
string |
Required |
Body Parameters
Authenticate via Authorization: Bearer <secret> header (required). Body: optional MeetingName, CallRecord, NotifyEmail, NotifyMessage, Password, RingDuration, FallbackUrl, FallbackMessage, ConferencePhoneNumber, AdditionalNotificationEmail, AdditionalNotificationMobile, OperatorEmails, AssistantKeysActive, AssistantKeysAutoExecute, Summarise, AutoSummarise, SendSummaryToHost, SendSummaryToParticipant, SummaryRecipientEmail
UpdateMeetingCampaignRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| MeetingName |
Meeting name. Defaults to "<operator name> Meeting" on create; left unchanged on update when omitted. |
string |
None. |
| CallRecord |
Record the meeting calls. Default true. |
boolean |
None. |
| NotifyEmail |
Send email notifications for the meeting. Default true. |
boolean |
None. |
| NotifyMessage |
Send SMS/message notifications for the meeting. Default true. |
boolean |
None. |
| Password |
Optional meeting password. |
string |
None. |
| RingDuration |
Ring duration in seconds before fallback. |
integer |
None. |
| FallbackUrl |
URL to redirect to when the call is not answered. |
string |
None. |
| FallbackMessage |
Message shown when the call is not answered. |
string |
None. |
| ConferencePhoneNumber |
Dial-in conference phone number; the passcode is derived from the campaign sequence. |
string |
None. |
| AdditionalNotificationEmail |
Extra email address to notify about the meeting, in addition to the normal participant/host notifications controlled by NotifyEmail. |
string |
None. |
| AdditionalNotificationMobile |
Extra mobile number to notify about the meeting, in addition to the normal participant/host notifications controlled by NotifyMessage. |
string |
None. |
| OperatorEmails |
Comma-separated operator login emails to assign to the meeting (Assign Operators). Each email must belong to an active operator in the caller's company; the creating operator is always included. |
string |
None. |
| AssistantKeysActive |
Comma-separated AssistantKeys enabled for the campaign (AI meeting summary assistants). |
string |
None. |
| AssistantKeysAutoExecute |
Comma-separated AssistantKeys that execute automatically after each meeting. |
string |
None. |
| Summarise |
Enable the AI meeting summary: when true and AssistantKeysActive is not supplied, the default meeting assistant (StpAssistants.IsDefault=1) is enabled on the campaign. The summary can then be generated on demand. |
boolean |
None. |
| AutoSummarise |
Automatically run the AI meeting summary after each meeting: when true and AssistantKeysAutoExecute is not supplied, the default meeting assistant is enabled AND set to auto-execute. Implies Summarise. |
boolean |
None. |
| SendSummaryToHost |
Email the AI summary link to the host after each meeting. Default false. |
boolean |
None. |
| SendSummaryToParticipant |
Email the AI summary link to participants after each meeting. Default false. |
boolean |
None. |
| SummaryRecipientEmail |
Who receives the AI meeting summary link (when SendSummaryToHost is true). Defaults to the operator's login email; on update, defaults to the meeting's current recipient when omitted. |
string |
None. |
Request Formats
application/json, text/json
{
"MeetingName": "sample string 1",
"CallRecord": true,
"NotifyEmail": true,
"NotifyMessage": true,
"Password": "sample string 2",
"RingDuration": 1,
"FallbackUrl": "sample string 3",
"FallbackMessage": "sample string 4",
"ConferencePhoneNumber": "sample string 5",
"AdditionalNotificationEmail": "sample string 6",
"AdditionalNotificationMobile": "sample string 7",
"OperatorEmails": "sample string 8",
"AssistantKeysActive": "sample string 9",
"AssistantKeysAutoExecute": "sample string 10",
"Summarise": true,
"AutoSummarise": true,
"SendSummaryToHost": true,
"SendSummaryToParticipant": true,
"SummaryRecipientEmail": "sample string 11"
}
application/xml, text/xml
<UpdateMeetingCampaignRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Controllers"> <AdditionalNotificationEmail>sample string 6</AdditionalNotificationEmail> <AdditionalNotificationMobile>sample string 7</AdditionalNotificationMobile> <AssistantKeysActive>sample string 9</AssistantKeysActive> <AssistantKeysAutoExecute>sample string 10</AssistantKeysAutoExecute> <AutoSummarise>true</AutoSummarise> <CallRecord>true</CallRecord> <ConferencePhoneNumber>sample string 5</ConferencePhoneNumber> <FallbackMessage>sample string 4</FallbackMessage> <FallbackUrl>sample string 3</FallbackUrl> <MeetingName>sample string 1</MeetingName> <NotifyEmail>true</NotifyEmail> <NotifyMessage>true</NotifyMessage> <OperatorEmails>sample string 8</OperatorEmails> <Password>sample string 2</Password> <RingDuration>1</RingDuration> <SendSummaryToHost>true</SendSummaryToHost> <SendSummaryToParticipant>true</SendSummaryToParticipant> <Summarise>true</Summarise> <SummaryRecipientEmail>sample string 11</SummaryRecipientEmail> </UpdateMeetingCampaignRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A detailed confirmation of the updated meeting: keys, URL, QR code, host, assigned operators and AI summary configuration
MeetingCreatedResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Created |
True when this call created a new meeting; false when it updated an existing one (MeetingKey was supplied in the request). |
boolean |
None. |
| MeetingKey |
Unique key of the meeting (Campaign.CampaignKey). Use this for api/v3/room/details lookups and future meeting management. |
globally unique identifier |
None. |
| MeetingId |
The unique meeting id used in JoinMeetingUrl/StartMeetingUrl (VerticalId-MeetingId). |
string |
None. |
| MeetingName |
The meeting name. |
string |
None. |
| JoinMeetingUrl |
Direct link to join the meeting room in the meet app (MeetAppDomain/join/{MeetingKey}). Resolves per environment. |
string |
None. |
| StartMeetingUrl |
Link the host uses to start the meeting from the portal (AppDomainUrl/?i={MeetingId}&StartMeeting=1). Resolves per environment. |
string |
None. |
| QRCodeUrl |
QR code image URL encoding StartMeetingUrl. |
string |
None. |
| CallRecord |
Whether meeting calls are recorded. |
boolean |
None. |
| Host |
The operator the meeting summary email is sent to when SendSummaryToHost is true. |
MeetingOperatorSummary |
None. |
| Operators |
Operators assigned to the meeting (Assign Operators), including the creating operator. |
Collection of MeetingOperatorSummary |
None. |
| SummaryEnabled |
Whether the AI meeting summary assistant is enabled on this meeting. |
boolean |
None. |
| AutoSummaryEnabled |
Whether the AI meeting summary runs automatically after each meeting. |
boolean |
None. |
| SendSummaryToHost |
Whether the summary link is emailed to the host after each meeting. |
boolean |
None. |
| SendSummaryToParticipant |
Whether the summary link is emailed to participants after each meeting. |
boolean |
None. |
| Message |
Human-readable confirmation of what was created, including AI summary status. |
string |
None. |
Response Formats
application/json, text/json
{
"Created": true,
"MeetingKey": "66361a07-c22e-4dfa-a89c-ad232e4d439c",
"MeetingId": "sample string 3",
"MeetingName": "sample string 4",
"JoinMeetingUrl": "sample string 5",
"StartMeetingUrl": "sample string 6",
"QRCodeUrl": "sample string 7",
"CallRecord": true,
"Host": {
"OperatorId": 1,
"Name": "sample string 2",
"Email": "sample string 3"
},
"Operators": [
{
"OperatorId": 1,
"Name": "sample string 2",
"Email": "sample string 3"
},
{
"OperatorId": 1,
"Name": "sample string 2",
"Email": "sample string 3"
}
],
"SummaryEnabled": true,
"AutoSummaryEnabled": true,
"SendSummaryToHost": true,
"SendSummaryToParticipant": true,
"Message": "sample string 13"
}
application/xml, text/xml
<MeetingCreatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Controllers">
<AutoSummaryEnabled>true</AutoSummaryEnabled>
<CallRecord>true</CallRecord>
<Created>true</Created>
<Host>
<Email>sample string 3</Email>
<Name>sample string 2</Name>
<OperatorId>1</OperatorId>
</Host>
<JoinMeetingUrl>sample string 5</JoinMeetingUrl>
<MeetingId>sample string 3</MeetingId>
<MeetingKey>66361a07-c22e-4dfa-a89c-ad232e4d439c</MeetingKey>
<MeetingName>sample string 4</MeetingName>
<Message>sample string 13</Message>
<Operators>
<MeetingOperatorSummary>
<Email>sample string 3</Email>
<Name>sample string 2</Name>
<OperatorId>1</OperatorId>
</MeetingOperatorSummary>
<MeetingOperatorSummary>
<Email>sample string 3</Email>
<Name>sample string 2</Name>
<OperatorId>1</OperatorId>
</MeetingOperatorSummary>
</Operators>
<QRCodeUrl>sample string 7</QRCodeUrl>
<SendSummaryToHost>true</SendSummaryToHost>
<SendSummaryToParticipant>true</SendSummaryToParticipant>
<StartMeetingUrl>sample string 6</StartMeetingUrl>
<SummaryEnabled>true</SummaryEnabled>
</MeetingCreatedResponse>