Update Group Status

Production Endpoint

https://apivisionsampling.innovatemr.com/api/v2

PUT

/pega/group/{GroupId}/status

This API is used to update group status. To mark Group as Live(Status 1), MaximumCostPerInterview should be updated in group.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "status":1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://apivisionsampling.innovatemr.com/api/v2/pega/group//status' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status":1
}'

Responses

🟢200OK

application/json

Body

Example

{
    "apiStatus": "success",
    "msg": "Group status is set as Paused",
    "group": {
        "Target": {
            "GeoIPCheck": 1,
            "Languages": [
                1
            ],
            "Country": "United States"
        },
        "Status": 2,
        "Name": "Group A Test",
        "N": 20,
        "IncidenceRate": 30,
        "CostPerInterview": 3.75,
        "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"
        }
    }
}

Modified at 2025-03-04 04:42:49

Get Group Details

Add Target to group