1. Buyer API
  • Supplier API – FAQ
  • Supplier API
    • Onboarding Process
    • Mapping
    • Survey Inventory Management
    • Respondent-Survey Flow
    • Statuses, Term Reasons & Categories
    • Onboarding Checklist
    • API Call Flow
    • Complete Validation Notifications
    • Frequently Asked Questions (FAQ)
    • Lookup Question Library
      GET
    • Set Global redirect URLs and Pixels for supplier’s
      PUT
    • Delete Global redirect URLs and Pixels for supplier’s account
      DELETE
    • Core Metadata Fields
      GET
    • Get Question Categories
      GET
    • Get Allocated Surveys (all live surveys)
      GET
    • Get Allocated Surveys By Id
      GET
    • Get Allocated Surveys By Date (live surveys only)
      GET
    • Get Allocated Surveys With Pagination (live surveys only)
      GET
    • Get Redirect Method for Survey
      GET
    • Set Redirect Method for Survey
      PUT
    • Delete Redirect Method for Survey
      DELETE
    • Get Closed Survey List (allocated to supplier only)
      GET
    • Get Survey Transactions data
      GET
    • Get Survey Transactions data By Date Range
      GET
    • Survey Allow for Unique IP
      POST
    • Allow Unique PID & IP
      POST
    • Get Panellist Profiling
      GET
    • Survey Availability Endpoint
      GET
    • Get Survey Stats data By Date Range
      GET
    • Get Questions By Category
      GET
    • Answer Lookup
      GET
    • Get Survey Transactions data By PID and survey number
      GET
    • Get PIDs for re-contact surveys (studies)
      GET
    • Get survey stats
      GET
    • Set Panellist Profiling
      POST
    • update Panellist Profiling
      PUT
    • get surveys for respondent
      POST
    • Respondent Pre Survey Check
      POST
    • Single Term Reason Category Code
      GET
    • term reason category
      GET
    • Get Allocated High Priority Surveys(All Live Surveys)
      GET
    • Get Survey Targeting
      GET
    • Get Quota for Survey
      GET
  • Buyer API - FAQ
  • Buyer API
    • Create Job
      POST
    • Update Job
      PUT
    • Get Job Details
      GET
    • Update Job Status
      PUT
    • Get Job List By Status
      POST
    • Create Group
      POST
    • Update Group
      PUT
    • Get Group Details
      GET
    • Update Group Status
      PUT
    • Add Target to group
      POST
    • Update Target to group
      PUT
    • Remove Target Question
      DELETE
    • Add Quota to Group
      POST
    • Update Group Quota
      PUT
    • Get Group Quotas
      GET
    • Get Group Feasibility
      GET
    • Feasibility (Find estimates)
      POST
    • Questions Library
      GET
    • Get Job Stats
      GET
    • Get Group Stats
      GET
    • Get Group Quota Stats
      GET
  • Postbacks/Redirects
    • Redirect URL
    • PostBack URL
    • Hashing Mechanism
  • HTTP Status Codes
  • Text Analyzer API - FAQ
  • Text Analyzer API
    • API Details
  1. Buyer API

Update Group Status

Production Endpoint
https://apivisionsampling.innovatemr.com/api/v2
Production Endpoint
https://apivisionsampling.innovatemr.com/api/v2
PUT
https://apivisionsampling.innovatemr.com/api/v2
/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
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
status
number 
optional
Default 2, 1 = Live, 2 = Pause
Example
{
    "status":1
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
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
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 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"
        }
    }
}
Previous
Get Group Details
Next
Add Target to group
Built with