
Get meeting invitation with the Zoom API
Returns the invitation text of a meeting, with the link and the dial-in details, ready to send to the invitees.
- Identifier
- zoom_get_meeting_invitation
The request
POST https://connect.reportei.com/api/tools/zoom_get_meeting_invitation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"meetingId": 1
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| meetingId | integer | Yes | Meeting ID, from List meetings. |
Supported connections
Your customer connects their Zoom account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/zoom, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/zoom_get_meeting_invitation. It becomes your agent's tool definition with no conversion.
Other Zoom tools
- Get userGETReturns the profile of a user: name, email, time zone, personal meeting ID and plan type.
- List meetingsGETLists the scheduled meetings of a user; instant meetings are not included. The response has meetings and next_page_token: pass next_page_token to read the next page.
- Get meetingGETReturns one meeting with its join_url, start_url, settings and, for a recurring meeting, its occurrences. The start_url expires in two hours, so read it again here when needed.
- Create meetingPOSTSchedules a meeting for a user and returns it with join_url and start_url. Zoom accepts up to 100 of these calls a day per host.
- Update meetingPATCHUpdates a meeting; only the fields sent change. With occurrence_id it changes one occurrence of a recurring meeting. Zoom accepts up to 100 updates a day per meeting.
- Delete meetingDELETEDeletes a meeting. Without occurrence_id a recurring meeting is deleted with all of its occurrences.
- List meeting registrantsGETLists the registrants of a meeting with registration turned on. Only approved registrants come back unless status says otherwise. Needs a Pro plan or higher. Pass next_page_token to read the next page.
- Create meeting registrantPOSTRegisters a person in a meeting with registration turned on and returns the registrant_id and the personal join_url. Zoom may email the registrant, depending on the meeting settings.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
