API V2
API V2
https://api.questionpro.{{env}}/a/api/v2/micropanel/members
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
[
{
"emailAddress": "[email protected]",
"firstName": "Test",
"middleName": "",
"lastName": "",
"source": "Panel API",
"mobileNumber": "",
"username": "test",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"password": "Test@123",
"profileFields": []
}
]
curl --location 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data '[
{
"emailAddress": "[email protected]",
"firstName": "Test",
"middleName": "",
"lastName": "",
"source": "Panel API",
"mobileNumber": "",
"username": "test",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"password": "Test@123",
"profileFields": []
}
]'
import requests
import json
url = "https://api.questionpro.{{env}}/a/api/v2/micropanel/members"
payload = json.dumps([
{
"emailAddress": "[email protected]",
"firstName": "Test",
"middleName": "",
"lastName": "",
"source": "Panel API",
"mobileNumber": "",
"username": "test",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"password": "Test@123",
"profileFields": []
}
])
headers = {
'Content-Type': 'application/json',
'apiKey': '{{api-key}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/micropanel/members',
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 =>'[
{
"emailAddress": "[email protected]",
"firstName": "Test",
"middleName": "",
"lastName": "",
"source": "Panel API",
"mobileNumber": "",
"username": "test",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"password": "Test@123",
"profileFields": []
}
]',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'apiKey: {{api-key}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"response": {
"totalMemberScanned": 1,
"newMemberAdded": 1,
"existingMember": 0,
"duplicateEmailAddress": 0,
"invalidEmailAddress": 0,
"invalidMobileNumber": 1,
"duplicateUsername": 0,
"invalidUsername": 0,
"rejectedCount": 0
},
"requestID": "77ec3026-cd50-449c-9b26-04a4e783362b"
}
{
"$schema": "http://json-schema.org/draft-06/schema# ",
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"invalidEmailAddress": {
"type": "integer"
},
"invalidMobileNumber": {
"type": "integer"
},
"totalMemberScanned": {
"type": "integer"
},
"invalidUsername": {
"type": "integer"
},
"duplicateUsername": {
"type": "integer"
},
"rejectedCount": {
"type": "integer"
},
"newMemberAdded": {
"type": "integer"
},
"existingMember": {
"type": "integer"
},
"duplicateEmailAddress": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"invalidEmailAddress",
"invalidMobileNumber",
"totalMemberScanned",
"invalidUsername",
"duplicateUsername",
"rejectedCount",
"newMemberAdded",
"existingMember",
"duplicateEmailAddress"
]
},
"requestID": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"response",
"requestID"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "BAD_REQUEST",
"httpStatusCode": 400,
"id" : "1000",
"message": "Invalid URL parameters",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"response": {
"error": {
"docs": www.questionpro.com/api/error-codes.html
"name": "UNAUTHORIZED",
"httpStatusCode": 401,
"id" : "1010",
"message": "Incorrect API Key",
"resourceUrl":"resource_url"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}
{
"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"
}
}
}
{
"$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"
]
}