PureBasic / Zoom API / Update registration questions
Back to Collection Items
IncludeFile "CkJsonArray.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
req.i = CkHttpRequest::ckCreate()
If req.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpRequest::setCkHttpVerb(req, "PATCH")
CkHttpRequest::setCkPath(req, "/v2/webinars/:webinarId/registrants/questions")
CkHttpRequest::setCkContentType(req, "multipart/form-data")
jsonFormData1.i = CkJsonArray::ckCreate()
If jsonFormData1.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckAddObjectAt(jsonFormData1,-1)
jsonObj_1.i = CkJsonArray::ckObjectAt(jsonFormData1,CkJsonArray::ckSize(jsonFormData1) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"field_name","org")
CkJsonObject::ckUpdateBool(jsonObj_1,"required",1)
CkJsonObject::ckDispose(jsonObj_1)
CkJsonArray::ckAddObjectAt(jsonFormData1,-1)
jsonObj_1 = CkJsonArray::ckObjectAt(jsonFormData1,CkJsonArray::ckSize(jsonFormData1) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"field_name","job_title")
CkJsonObject::ckUpdateBool(jsonObj_1,"required",0)
CkJsonObject::ckDispose(jsonObj_1)
CkHttpRequest::ckAddParam(req,"questions",CkJsonArray::ckEmit(jsonFormData1))
jsonFormData2.i = CkJsonArray::ckCreate()
If jsonFormData2.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonArray::ckAddObjectAt(jsonFormData2,-1)
jsonObj_1.i = CkJsonArray::ckObjectAt(jsonFormData2,CkJsonArray::ckSize(jsonFormData2) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"field_name","org")
CkJsonObject::ckUpdateBool(jsonObj_1,"required",1)
CkJsonObject::ckDispose(jsonObj_1)
CkJsonArray::ckAddObjectAt(jsonFormData2,-1)
jsonObj_1 = CkJsonArray::ckObjectAt(jsonFormData2,CkJsonArray::ckSize(jsonFormData2) - 1)
CkJsonObject::ckUpdateString(jsonObj_1,"field_name","job_title")
CkJsonObject::ckUpdateBool(jsonObj_1,"required",0)
CkJsonObject::ckDispose(jsonObj_1)
CkHttpRequest::ckAddParam(req,"custom_questions",CkJsonArray::ckEmit(jsonFormData2))
CkHttpRequest::ckAddHeader(req,"Authorization","Bearer <access_token>")
resp.i = CkHttp::ckSynchronousRequest(http,"api.zoom.us",443,1,req)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkJsonArray::ckDispose(jsonFormData1)
CkJsonArray::ckDispose(jsonFormData2)
ProcedureReturn
EndIf
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode <> 204
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Response Body:"
Debug CkHttpResponse::ckBodyStr(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkJsonArray::ckDispose(jsonFormData1)
CkJsonArray::ckDispose(jsonFormData2)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
Debug "Success."
CkHttp::ckDispose(http)
CkHttpRequest::ckDispose(req)
CkJsonArray::ckDispose(jsonFormData1)
CkJsonArray::ckDispose(jsonFormData2)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'questions=[{"field_name":"org","required":true},{"field_name":"job_title","required":false}]'
--form 'custom_questions=[{"field_name":"org","required":true},{"field_name":"job_title","required":false}][{"title":"","type":"single_dropdown","required":true,"answers":["culpa elit","tempor amet culpa nostrud ullamco"]},{"title":"est in incididunt occaecat","type":"short","required":true,"answers":["culpa nulla","laborum pariatur aliqua minim"]}]'
https://api.zoom.us/v2/webinars/:webinarId/registrants/questions
Postman Collection Item JSON
{
"name": "Update registration questions",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "questions",
"value": "[{\"field_name\":\"org\",\"required\":true},{\"field_name\":\"job_title\",\"required\":false}]",
"description": "undefined",
"type": "text"
},
{
"key": "custom_questions",
"value": "[{\"title\":\"\",\"type\":\"single_dropdown\",\"required\":true,\"answers\":[\"culpa elit\",\"tempor amet culpa nostrud ullamco\"]},{\"title\":\"est in incididunt occaecat\",\"type\":\"short\",\"required\":true,\"answers\":[\"culpa nulla\",\"laborum pariatur aliqua minim\"]}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants/questions",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants",
"questions"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Scheduling a [Webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.<br>Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.<br><br>\n**Prerequisites:**<br> \n* Pro or higher plan with a Webinar Add-on.\n* Registration option for Webinar should be set as required to use this API. \n**Scopes:** `webinar:write:admin` `webinar:write`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n"
},
"response": [
{
"name": "**HTTP Status Code:** `204`<br>Webinar Registrant Questions Updated",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "questions",
"value": "[{\"field_name\":\"country\",\"required\":true},{\"field_name\":\"zip\",\"required\":false}]",
"description": "undefined",
"type": "text"
},
{
"key": "custom_questions",
"value": "[{\"title\":\"commodo magna incididunt\",\"type\":\"short\",\"required\":true,\"answers\":[\"sunt eu\",\"exercitation nulla eiusmod Lorem\"]},{\"title\":\"aliqua cupidatat Excepteur sit\",\"type\":\"multiple\",\"required\":true,\"answers\":[\"do tempor \",\"in ut\"]}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants/questions",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants",
"questions"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>Webinar not found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "questions",
"value": "[{\"field_name\":\"country\",\"required\":true},{\"field_name\":\"zip\",\"required\":false}]",
"description": "undefined",
"type": "text"
},
{
"key": "custom_questions",
"value": "[{\"title\":\"commodo magna incididunt\",\"type\":\"short\",\"required\":true,\"answers\":[\"sunt eu\",\"exercitation nulla eiusmod Lorem\"]},{\"title\":\"aliqua cupidatat Excepteur sit\",\"type\":\"multiple\",\"required\":true,\"answers\":[\"do tempor \",\"in ut\"]}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/registrants/questions",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"registrants",
"questions"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
