Add Quota to Group

Request

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Content-Type

string

required

application/json

Body Params application/json

Title

string

required

Quota Name for Quota

HardStop

boolean

required

Hard Stop to Quota if required N is achieved. Default is false.

HardStopType

integer

required

Hard Stop on Click or Completes. 0 - Survey Complete and 1 - Survey Click

N

integer

required

Number of Click/Completes you need into Quota

GroupId

integer

required

Group Id to add Quota into that Group

Conditions

object

required

It will have targets options conditions(all targets to add here should be added in targets first). Minimum 1 and maximum 3 targets can be added here. e.g: {“AGE”: [“18-35”], “GENDER”: [1, 2], “ZIPCODES”: [“23213”, “34543”]}

AGE

array[string]

required

GENDER

array[integer]

required

ZIPCODES

array[string]

required

Example

{
    "Title": "Sample Quota",
    "HardStop": false,
    "HardStopType": 0,
    "N": 100,
    "GroupId": 12345,
    "Conditions": {
        "AGE": [
            "18-35"
        ],
        "GENDER": [
            1,
            2
        ],
        "ZIPCODES": [
            "23213",
            "34543"
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apivisionsampling.innovatemr.com/api/v2/pega/quota' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Title": "Sample Quota",
    "HardStop": false,
    "HardStopType": 0,
    "N": 100,
    "GroupId": 12345,
    "Conditions": {
        "AGE": [
            "18-35"
        ],
        "GENDER": [
            1,
            2
        ],
        "ZIPCODES": [
            "23213",
            "34543"
        ]
    }
}'

Responses

🟢200Success

application/json

Body

apiStatus

string

required

msg

string

required

Quota

object

required

HardStop

boolean

required

Status

integer

required

HardStopType

integer

required

N

integer

required

Title

string

required

Conditions

object

required

GroupId

integer

required

JobId

integer

required

Id

integer

required

CreatedDate

string

required

Example

{
    "apiStatus": "success",
    "msg": "Quota is successfully created.",
    "Quota": {
        "HardStop": true,
        "Status": 1,
        "HardStopType": 0,
        "N": 5,
        "Title": "Male ",
        "Conditions": {
            "AGE": [
                {
                    "OptionId": 1,
                    "AgeStart": 26,
                    "AgeEnd": 35
                },
                {
                    "OptionId": 2,
                    "AgeStart": 51,
                    "AgeEnd": 60
                }
            ]
        },
        "GroupId": 19254,
        "JobId": 8528,
        "Id": 12130,
        "CreatedDate": "2019-01-11T13:48:56.884Z"
    }
}