Surveys: reserve

Permits an organisation to increase its stock of assignable surveys.

The surveys/reserve method permits an organisation to increase its stock of assignable surveys. Surveys can be assigned to respondents under two circumstances:

  1. The users/create action has a parameter – auto_assign – which expects a valid JSON structure. See Adding users.
  2. The organisation has enough pre-reserved, unassigned surveys in stock (in which case option one becomes moot)

This topic deals only with the latter scenario, where sufficient pre-reserved, un-assigned surveys already exist in your organisation. There may be a price advantage to reserving surveys for your organisation in bulk, in which case this surveys/reserve method would serve you well. If not, using auto_assign when creating would be analogous to reserving n surveys with this reserve method.

This method permits ad-hoc assigning the reserved survey(s) to a user later on.

Basic request:

POST https://{APIDOMAIN}/api-v1/surveys/reserve

Required parameters:

  • q Integer between 1 and 100

Typical response on success:

{
    "message": "15 surveys were allocated to PfP Test Organisation. New balance: 65"
}