Chilkat Online Tools

phpExt / Zoom API / Update a meeting survey

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// 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/meetings/:meetingId/survey');
$req->put_ContentType('multipart/form-data');
$req->AddParam('third_party_survey','consequ');

$req->AddParam('custom_survey','consequ{\'anonymous\':false,\'questions\':[{\'name\':\'sit veniam sint tempor\',\'type\':\'rating_scale\',\'show_as_dropdown\':false,\'answer_required\':false,\'answers\':[\'adipisicing\',\'labore sunt\'],\'answer_min_character\':93150996,\'answer_max_character\':55152689,\'rating_min_value\':24082607,\'rating_max_value\':-38991075,\'rating_min_label\':\'ipsum sint\',\'rating_max_label\':\'culpa amet do eiusmod\'},{\'name\':\'aliquip labore amet dolore\',\'type\':\'rating_scale\',\'show_as_dropdown\':false,\'answer_required\':false,\'answers\':[\'nis\',\'irure nisi reprehenderit veniam su\'],\'answer_min_character\':74190569,\'answer_max_character\':-139512,\'rating_min_value\':12745345,\'rating_max_value\':-45231118,\'rating_min_label\':\'in consectetur\',\'rating_max_label\':\'in nisi deserunt commodo\'}]}');

$req->AddParam('show_in_the_browser','consequ{\'anonymous\':false,\'questions\':[{\'name\':\'sit veniam sint tempor\',\'type\':\'rating_scale\',\'show_as_dropdown\':false,\'answer_required\':false,\'answers\':[\'adipisicing\',\'labore sunt\'],\'answer_min_character\':93150996,\'answer_max_character\':55152689,\'rating_min_value\':24082607,\'rating_max_value\':-38991075,\'rating_min_label\':\'ipsum sint\',\'rating_max_label\':\'culpa amet do eiusmod\'},{\'name\':\'aliquip labore amet dolore\',\'type\':\'rating_scale\',\'show_as_dropdown\':false,\'answer_required\':false,\'answers\':[\'nis\',\'irure nisi reprehenderit veniam su\'],\'answer_min_character\':74190569,\'answer_max_character\':-139512,\'rating_min_value\':12745345,\'rating_max_value\':-45231118,\'rating_min_label\':\'in consectetur\',\'rating_max_label\':\'in nisi deserunt commodo\'}]}true');

$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 'third_party_survey=consequ'
	--form 'custom_survey=consequ{"anonymous":false,"questions":[{"name":"sit veniam sint tempor","type":"rating_scale","show_as_dropdown":false,"answer_required":false,"answers":["adipisicing","labore sunt"],"answer_min_character":93150996,"answer_max_character":55152689,"rating_min_value":24082607,"rating_max_value":-38991075,"rating_min_label":"ipsum sint","rating_max_label":"culpa amet do eiusmod"},{"name":"aliquip labore amet dolore","type":"rating_scale","show_as_dropdown":false,"answer_required":false,"answers":["nis","irure nisi reprehenderit veniam su"],"answer_min_character":74190569,"answer_max_character":-139512,"rating_min_value":12745345,"rating_max_value":-45231118,"rating_min_label":"in consectetur","rating_max_label":"in nisi deserunt commodo"}]}'
	--form 'show_in_the_browser=consequ{"anonymous":false,"questions":[{"name":"sit veniam sint tempor","type":"rating_scale","show_as_dropdown":false,"answer_required":false,"answers":["adipisicing","labore sunt"],"answer_min_character":93150996,"answer_max_character":55152689,"rating_min_value":24082607,"rating_max_value":-38991075,"rating_min_label":"ipsum sint","rating_max_label":"culpa amet do eiusmod"},{"name":"aliquip labore amet dolore","type":"rating_scale","show_as_dropdown":false,"answer_required":false,"answers":["nis","irure nisi reprehenderit veniam su"],"answer_min_character":74190569,"answer_max_character":-139512,"rating_min_value":12745345,"rating_max_value":-45231118,"rating_min_label":"in consectetur","rating_max_label":"in nisi deserunt commodo"}]}true'
https://api.zoom.us/v2/meetings/:meetingId/survey

Postman Collection Item JSON

{
  "name": "Update a meeting survey",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "third_party_survey",
          "value": "consequ",
          "description": "undefined",
          "type": "text"
        },
        {
          "key": "custom_survey",
          "value": "{\"anonymous\":false,\"questions\":[{\"name\":\"sit veniam sint tempor\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"adipisicing\",\"labore sunt\"],\"answer_min_character\":93150996,\"answer_max_character\":55152689,\"rating_min_value\":24082607,\"rating_max_value\":-38991075,\"rating_min_label\":\"ipsum sint\",\"rating_max_label\":\"culpa amet do eiusmod\"},{\"name\":\"aliquip labore amet dolore\",\"type\":\"rating_scale\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"nis\",\"irure nisi reprehenderit veniam su\"],\"answer_min_character\":74190569,\"answer_max_character\":-139512,\"rating_min_value\":12745345,\"rating_max_value\":-45231118,\"rating_min_label\":\"in consectetur\",\"rating_max_label\":\"in nisi deserunt commodo\"}]}",
          "description": "undefined",
          "type": "text"
        },
        {
          "key": "show_in_the_browser",
          "value": "true",
          "description": "undefined",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/meetings/:meetingId/survey",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "meetings",
        ":meetingId",
        "survey"
      ],
      "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": "Use this API to update a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). \n\n **Scopes:** `meeting:write`, `meeting:write:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n **Prerequisites:** \n* The host must be a **Pro** user type. \n* The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account. \n* The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204` <br>\n Meeting survey updated.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "third_party_survey",
              "value": "labo",
              "description": "undefined",
              "type": "text"
            },
            {
              "key": "custom_survey",
              "value": "{\"anonymous\":false,\"questions\":[{\"name\":\"c\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"ipsum in\",\"Excepteur dolore tempor\"],\"answer_min_character\":59714976,\"answer_max_character\":-85740401,\"rating_min_value\":32810652,\"rating_max_value\":-26694597,\"rating_min_label\":\"ex do sunt\",\"rating_max_label\":\"veniam officia laborum qui culpa\"},{\"name\":\"occaecat pariatur sint\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"ullamco dolor tempor in\",\"adipisicing exercitation\"],\"answer_min_character\":14373402,\"answer_max_character\":-93427197,\"rating_min_value\":51576458,\"rating_max_value\":-41859939,\"rating_min_label\":\"aliquip laboris\",\"rating_max_label\":\"sed culpa\"}]}",
              "description": "undefined",
              "type": "text"
            },
            {
              "key": "show_in_the_browser",
              "value": "true",
              "description": "undefined",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/survey",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "survey"
          ],
          "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": "**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n * Invalid meeting ID. <br>\n * Invalid third party survey: {third_party_survey}. \n\n **Error Code:** `3000` <br>\n * Cannot access Webinar information. <br>\n * Meeting survey disable",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "third_party_survey",
              "value": "labo",
              "description": "undefined",
              "type": "text"
            },
            {
              "key": "custom_survey",
              "value": "{\"anonymous\":false,\"questions\":[{\"name\":\"c\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"ipsum in\",\"Excepteur dolore tempor\"],\"answer_min_character\":59714976,\"answer_max_character\":-85740401,\"rating_min_value\":32810652,\"rating_max_value\":-26694597,\"rating_min_label\":\"ex do sunt\",\"rating_max_label\":\"veniam officia laborum qui culpa\"},{\"name\":\"occaecat pariatur sint\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"ullamco dolor tempor in\",\"adipisicing exercitation\"],\"answer_min_character\":14373402,\"answer_max_character\":-93427197,\"rating_min_value\":51576458,\"rating_max_value\":-41859939,\"rating_min_label\":\"aliquip laboris\",\"rating_max_label\":\"sed culpa\"}]}",
              "description": "undefined",
              "type": "text"
            },
            {
              "key": "show_in_the_browser",
              "value": "true",
              "description": "undefined",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/survey",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "survey"
          ],
          "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> Not Found \n\n **Error Code:** `300` <br>\n Meeting ID does not exist. \n\n **Error Code:** `3001` <br>\n Meeting does not exist: {meetingId}.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "third_party_survey",
              "value": "labo",
              "description": "undefined",
              "type": "text"
            },
            {
              "key": "custom_survey",
              "value": "{\"anonymous\":false,\"questions\":[{\"name\":\"c\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"ipsum in\",\"Excepteur dolore tempor\"],\"answer_min_character\":59714976,\"answer_max_character\":-85740401,\"rating_min_value\":32810652,\"rating_max_value\":-26694597,\"rating_min_label\":\"ex do sunt\",\"rating_max_label\":\"veniam officia laborum qui culpa\"},{\"name\":\"occaecat pariatur sint\",\"type\":\"single\",\"show_as_dropdown\":false,\"answer_required\":false,\"answers\":[\"ullamco dolor tempor in\",\"adipisicing exercitation\"],\"answer_min_character\":14373402,\"answer_max_character\":-93427197,\"rating_min_value\":51576458,\"rating_max_value\":-41859939,\"rating_min_label\":\"aliquip laboris\",\"rating_max_label\":\"sed culpa\"}]}",
              "description": "undefined",
              "type": "text"
            },
            {
              "key": "show_in_the_browser",
              "value": "true",
              "description": "undefined",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/survey",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "survey"
          ],
          "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": ""
    }
  ]
}