Chilkat Online Tools

phpExt / Zoom API / Update registration questions

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$req = new CkHttpRequest();
$req->put_HttpVerb('PATCH');
$req->put_Path('/v2/webinars/:webinarId/registrants/questions');
$req->put_ContentType('multipart/form-data');

$jsonFormData1 = new CkJsonArray();

$jsonFormData1->AddObjectAt(-1);
// jsonObj_1 is a CkJsonObject
$jsonObj_1 = $jsonFormData1->ObjectAt($jsonFormData1->get_Size() - 1);
$jsonObj_1->UpdateString('field_name','org');
$jsonObj_1->UpdateBool('required',true);

$jsonFormData1->AddObjectAt(-1);
// jsonObj_1 is a CkJsonObject
$jsonObj_1 = $jsonFormData1->ObjectAt($jsonFormData1->get_Size() - 1);
$jsonObj_1->UpdateString('field_name','job_title');
$jsonObj_1->UpdateBool('required',false);

$req->AddParam('questions',$jsonFormData1->emit());

$jsonFormData2 = new CkJsonArray();

$jsonFormData2->AddObjectAt(-1);
// jsonObj_1 is a CkJsonObject
$jsonObj_1 = $jsonFormData2->ObjectAt($jsonFormData2->get_Size() - 1);
$jsonObj_1->UpdateString('field_name','org');
$jsonObj_1->UpdateBool('required',true);

$jsonFormData2->AddObjectAt(-1);
// jsonObj_1 is a CkJsonObject
$jsonObj_1 = $jsonFormData2->ObjectAt($jsonFormData2->get_Size() - 1);
$jsonObj_1->UpdateString('field_name','job_title');
$jsonObj_1->UpdateBool('required',false);

$req->AddParam('custom_questions',$jsonFormData2->emit());

$req->AddHeader('Authorization','Bearer <access_token>');

// resp is a CkHttpResponse
$resp = $http->SynchronousRequest('api.zoom.us',443,true,$req);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode != 204) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Response Body:' . "\n";
    print $resp->bodyStr() . "\n";
    print 'Failed.' . "\n";

    exit;
}

print 'Success.' . "\n";

?>

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": ""
    }
  ]
}