- Method: POST
- Complete URL: https://api.webinarjam.com/everwebinar/unsubscribe
The request must include all of the required fields, based on the table below:
| Name | Value |
| api_key* | string(64) |
| webinar_id* | integer |
| lead_id*{+} | integer |
* Required fields
{+} lead_id must be retrieved from a previous API call to retrieve a list of registrants and attendees of the specific webinar you are looking at.
Example CURL request
curl --data "api_key=demokey&webinar_id=561&lead_id=818" https://api.webinarjam.com/everwebinar/unsubscribe
API Call Response
In response to the API call, the output will show a “204 No Content” success message indicating that the lead has been unsubscribed from the webinar. The user will not receive any pending webinar notifications.
Verifying Subscription Status
After the API call, you can verify if a registrant has been unsubscribed from the webinar:
- Go to Registrants.
- Choose the Webinar Name, Session and Event.
- Click Go.
- Scroll right to the Subscribed column.
- The column will show “No” after the API call runs successfully.
