Update Group

Request

Path Params

GroupId

number

required

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Content-Type

string

required

application/json

Body Params application/json

Name

string

required

Group Name

N

integer

required

IncidenceRate

integer

required

1 to 100

EstCostPerInterview

number

required

Estimated Cost in USD for Internal use only

LengthOfInterview

integer

required

1 to 45 minutes

LiveSurveyUrl

string

required

Url Length can be maximum 1000 chars. Example: http://www.survey.com?tk=[%%token%%]&pid=[%%pid%%]

TestSurveyUrl

string

required

Same as Live Url

Color

integer

required

Default 0, 0 = White/None, 1 = Yellow and 2 = Red

Priority

integer

required

Default 0, 0 = Normal, 1 = High and 2 = Critical

DeviceType

integer

required

Default 6(All)

Target

object

required

GeoIPCheck

integer

required

Default 1, 0 = false and 1 = true

Country

string

required

Country Name. Example:“United States” Please check Country list for other country names

Languages

string

required

Language Name. Example: “ENGLISH” Please check Language list for other Language names

Note

string

required

Note to add any specific information

MaximumCostPerInterview

integer

required

MaximumCostPerInterview should be always greater than or equal to Cost per Interview.

Status

number

optional

Default 2, 1 = Live, 2 = Pause

FieldingEndDate

string

optional

End Date of fielding setup like Year-Month-Date (Example-“FieldingEndDate”: “2021-04-20”)

Example

{
    "Name": "Sample Group",
    "N": 100,
    "IncidenceRate": 80,
    "EstCostPerInterview": 5.5,
    "LengthOfInterview": 30,
    "LiveSurveyUrl": "http://www.survey.com?tk=[%%token%%]&pid=[%%pid%%]",
    "TestSurveyUrl": "http://www.survey.com?tk=[%%token%%]&pid=[%%pid%%]",
    "Color": 0,
    "Priority": 1,
    "DeviceType": 6,
    "Target": {
        "GeoIPCheck": 1,
        "Country": "United States",
        "Languages": "ENGLISH"
    },
    "Note": "This is a sample note.",
    "MaximumCostPerInterview": 10.0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://apivisionsampling.innovatemr.com/api/v2/pega/group/' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "Sample Group",
    "N": 100,
    "IncidenceRate": 80,
    "EstCostPerInterview": 5.5,
    "LengthOfInterview": 30,
    "LiveSurveyUrl": "http://www.survey.com?tk=[%%token%%]&pid=[%%pid%%]",
    "TestSurveyUrl": "http://www.survey.com?tk=[%%token%%]&pid=[%%pid%%]",
    "Color": 0,
    "Priority": 1,
    "DeviceType": 6,
    "Target": {
        "GeoIPCheck": 1,
        "Country": "United States",
        "Languages": "ENGLISH"
    },
    "Note": "This is a sample note.",
    "MaximumCostPerInterview": 10.0
}'

Responses

🟢200Success

application/json

Body

apiStatus

string

required

msg

string

required

group

object

required

Target

object

required

Status

integer

required

Name

string

required

N

integer

required

IncidenceRate

integer

required

CostPerInterview

number

required

EstCostPerInterview

integer

required

LengthOfInterview

integer

required

LiveSurveyUrl

string

required

JobId

integer

required

CompanyId

integer

required

DeviceType

integer

required

CountryCode

string

required

Language

string

required

Id

integer

required

CreatedDate

string

required

SID

string

required

TestSurveyUrl

string

required

Fielding

object

required

Example

{
    "apiStatus": "success",
    "msg": "Group is successfully accepted",
    "group": {
        "Target": {
            "GeoIPCheck": 1,
            "Languages": [
                1
            ],
            "Country": "United States"
        },
        "Status": 1,
        "Name": "Group A Test",
        "N": 20,
        "IncidenceRate": 30,
        "CostPerInterview": 3.75,
        "EstCostPerInterview": 2,
        "LengthOfInterview": 3,
        "LiveSurveyUrl": "http://www.survey.com?tk=[%%token%%]&pid=[%%pid%%]",
        "JobId": 8575,
        "CompanyId": 44,
        "DeviceType": 6,
        "CountryCode": "US",
        "Language": "ENGLISH",
        "Id": 19427,
        "CreatedDate": "2018-12-05T13:15:54.745Z",
        "SID": "ev9wL269",
        "TestSurveyUrl": "",
        "Fielding": {
            "FieldingStartDate": "2021-04-12T07:00:00.000Z",
            "FieldingEndDate": "2021-04-23T06:59:59.999Z"
        }
    }