API V2

Schedule Invitation keyboard_arrow_down

Post /surveys/{{survey-id}}/batches/schedule

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/schedule

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.


Authorization

arrow_rightSecurity - API Key
Name : api-key
required
Location : Request Header
Type : string

Request Parameters

arrow_rightPath Parameters
survey-id integer
required

Request Body

arrow_rightPayload
application/json 

                          {
                                "emails":["[email protected]","[email protected]"],
                                "emailTemplate":{
                                    "emailSubject":"Lets get it started",
                                    "content":"And the beat goes boom"
                                },
                                "mode":4,
                                 "dateTime": "2024-01-31T21:15:00+05:30"
                            }

Example Code

arrow_rightcURL
application/json 

curl --location 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/schedule' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data-raw '{
        "emails":["[email protected]","[email protected]"],
        "emailTemplate":{
            "emailSubject":"Lets get it started",
            "content":"And the beat goes boom"
        },
        "mode":4,
         "dateTime": "2024-01-31T21:10:00+05:30"
    }'
arrow_rightPython
application/json 

import requests
import json

url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/schedule"

payload = json.dumps({
  "emails": [
    "[email protected]",
    "[email protected]"
  ],
  "emailTemplate": {
    "emailSubject": "Lets get it started",
    "content": "And the beat goes boom"
  },
  "mode": 4,
  "dateTime": "2024-01-31T21:10:00+05:30"
})
headers = {
  'Content-Type': 'application/json',
  'api-key': '{{api-key}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
arrow_rightPHP
application/json 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/batches/schedule',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
        "emails":["[email protected]","[email protected]"],
        "emailTemplate":{
            "emailSubject":"Lets get it started",
            "content":"And the beat goes boom"
        },
        "mode":4,
         "dateTime": "2024-01-31T21:10:00+05:30"
    }',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'api-key: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Responses

arrow_rightExample
application/json 

                       {
                            "response":  {
                                "scheduledInvitationID": 54322,
                                "surveyID": 9000001,
                                "userID": 1234567,
                                "emailBatchID": 0,
                                "invitationTemplateID": -1,
                                "emailGroupID": 8000001,
                                "status": 0,
                                "emailText": "And the beat goes boom",
                                "emailSubject": "Lets get it started",
                                "scheduleDate": "2024-01-31",
                                "scheduleHour": 7,
                                "emailFrom": "[email protected]",
                                "createdTimestamp": "2020-10-05T20:53:05.391+0000"
                            },
                            "requestID": "5012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
                        }
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "surveyID": {
          "type": "integer"
        },
        "scheduledInvitationID": {
          "type": "integer"
        },
        "scheduleHour": {
          "type": "integer"
        },
        "createdTimestamp": {
          "type": "string"
        },
        "emailText": {
          "type": "string"
        },
        "userID": {
          "type": "integer"
        },
        "emailSubject": {
          "type": "string"
        },
        "emailGroupID": {
          "type": "integer"
        },
        "emailBatchID": {
          "type": "integer"
        },
        "scheduleDate": {
          "type": "string"
        },
        "emailFrom": {
          "type": "string",
          "format": "email"
        },
        "invitationTemplateID": {
          "type": "integer"
        },
        "status": {
          "type": "integer"
        }
      },
      "additionalProperties": false,
      "required": [
        "surveyID",
        "scheduledInvitationID",
        "scheduleHour",
        "createdTimestamp",
        "emailText",
        "userID",
        "emailSubject",
        "emailGroupID",
        "emailBatchID",
        "scheduleDate",
        "emailFrom",
        "invitationTemplateID",
        "status"
      ]
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "response",
    "requestID"
  ]
}
arrow_right400 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "BAD_REQUEST",
         "httpStatusCode": 400,
         "id" : "1000",
         "message": "Invalid URL parameters",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right401 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "UNAUTHORIZED",
         "httpStatusCode": 401,
         "id" : "1010",
         "message": "Incorrect API Key",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right403 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "FORBIDDEN",
         "httpStatusCode": 403,
         "id" : "1013",
         "message": "The user does not have permission to access the resource",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right404 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "NOT_FOUND",
         "httpStatusCode": 404,
         "id" : "1040",
         "message": "The resource that you're trying to access doesn't exist",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right500 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "INTERNAL_SERVER_ERROR",
         "httpStatusCode": 500,
         "id" : "1026",
         "message": "We are not able to process your request",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}