DataFlex / Zoom API / Update registrant's status
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Integer iRespStatusCode
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "PUT"
Set ComPath Of hoReq To "/"
Set ComContentType Of hoReq To "multipart/form-data"
Send ComAddParam To hoReq "action" "deny"
Send ComAddParam To hoReq "registrants" 'deny[{"id":"in ad ut nulla est","email":"nulla"},{"id":"pariatur aute","email":"incididunt fugiat mollit consequat"}]'
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "reprehenderit" 80 False vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode <> 204) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Response Body:"
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
Showln "Success."
End_Procedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'action=deny'
--form 'registrants=deny[{"id":"in ad ut nulla est","email":"nulla"},{"id":"pariatur aute","email":"incididunt fugiat mollit consequat"}]'
https://api.zoom.us/v2/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit
Postman Collection Item JSON
{
"name": "Update registrant's status",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "deny",
"description": "(Required) Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant. (This can only be one of approve,cancel,deny)",
"type": "text"
},
{
"key": "registrants",
"value": "[{\"id\":\"in ad ut nulla est\",\"email\":\"nulla\"},{\"id\":\"pariatur aute\",\"email\":\"incididunt fugiat mollit consequat\"}]",
"description": "List of registrants.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"registrants",
"status"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit",
"description": "The meeting or webinar occurrence ID."
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
},
"description": "Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.<br><br>\n**Scopes:** `meeting:write:admin` `meeting:write`\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `204`<br>\nRegistrant status updated.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "cancel",
"description": "(Required) Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant. (This can only be one of approve,cancel,deny)",
"type": "text"
},
{
"key": "registrants",
"value": "[{\"id\":\"aliquip ex do\",\"email\":\"officia eiusmod aliquip minim\"},{\"id\":\"dolore non\",\"email\":\"Duis non\"}]",
"description": "List of registrants.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"registrants",
"status"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**Error Code:** `300`<br>\nThis meeting has not set registration as required:{meetingId}.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "cancel",
"description": "(Required) Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant. (This can only be one of approve,cancel,deny)",
"type": "text"
},
{
"key": "registrants",
"value": "[{\"id\":\"aliquip ex do\",\"email\":\"officia eiusmod aliquip minim\"},{\"id\":\"dolore non\",\"email\":\"Duis non\"}]",
"description": "List of registrants.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"registrants",
"status"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId}.<br>\n**Error Code:** `3000`<br>\nCannot access meeting information.<br>\n**Error Code:** `3003`<br>\nYou're not the meeting host.\n\n",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "cancel",
"description": "(Required) Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant. (This can only be one of approve,cancel,deny)",
"type": "text"
},
{
"key": "registrants",
"value": "[{\"id\":\"aliquip ex do\",\"email\":\"officia eiusmod aliquip minim\"},{\"id\":\"dolore non\",\"email\":\"Duis non\"}]",
"description": "List of registrants.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"registrants",
"status"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\nMeeting or registrant not found.\n**Error Code:** `1001`<br>\nUser does not exist: {userId}.<br>\n",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "cancel",
"description": "(Required) Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant. (This can only be one of approve,cancel,deny)",
"type": "text"
},
{
"key": "registrants",
"value": "[{\"id\":\"aliquip ex do\",\"email\":\"officia eiusmod aliquip minim\"},{\"id\":\"dolore non\",\"email\":\"Duis non\"}]",
"description": "List of registrants.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"registrants",
"status"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `429` <br> You have exceeded the daily rate limit of \"{0}\" for meeting **Update registrant's status** API requests for the registrant \"{1}\". You can resume these API requests at GMT 00:00:00.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "cancel",
"description": "(Required) Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant. (This can only be one of approve,cancel,deny)",
"type": "text"
},
{
"key": "registrants",
"value": "[{\"id\":\"aliquip ex do\",\"email\":\"officia eiusmod aliquip minim\"},{\"id\":\"dolore non\",\"email\":\"Duis non\"}]",
"description": "List of registrants.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/meetings/:meetingId/registrants/status?occurrence_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"meetings",
":meetingId",
"registrants",
"status"
],
"query": [
{
"key": "occurrence_id",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "meetingId",
"value": "68423085",
"description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}