Updates the demographic quota group specified by the QuotaGroupGuid parameter.

Endpoint URL

http://api.clearvoicesurveys.com/api/v1/quotagroups/updatequotagroup

Parameters

ProjectGuid
globally unique identifier		 ClearVoice's unique identifier for the project the quota group should be created in.

Required
QuotaGroupGuid
globally unique identifier		 The key that identifies which quota group to update

Required
QuotaGroupName
string		 Set to change the name of the quota group

String length: inclusive between 2 and 100
IsOpen
boolean		 Set to change the quota group status. If set to false then the quota group will be closed If set to true then the quota group will be opened
RequestedCompletes
integer		 The requested completes for the quota group.
BidResponseRate
decimal number		 The bid response rate, expressed as a percentage. For example, set to 80 for a 80% bid response rate.
IncidenceRate
decimal number		 The incidence rate, expressed as a percentage. For example, set to 80 for a 80% incidence rate. This is required in order to calculate CPI based on the rate card for the partner.
AllowDynamicSurveys
boolean		 Configures the quota group to allow dynamic surveys.
AllowExternalSuppliers
boolean		 If true the current suppliers enabled in the system will be enabled to allow them to source this quota group.
Demographics
Collection of DemographicCriteria 		The demographics and answers used as the quota group's matching criteria, used to determine which members to target. Each entry in the Demographics collection acts as an AND clause. Each entry in the Answers collection acts as an OR clause. For example, in order to target males only, who live in ZIP codes 32256 or 80202, and who own a dog or a cat, the Demographics collection and their child Answers collections should contain the following entries: (gender, Answers: (male)), (zip, Answers: (32256, 80202)), (pet, Answers: (cat, dog)). This translates into the following logical expression: (gender = male) AND (zip=32256 OR zip=80202) AND (pet=cat OR pet=dog).
QuotaGroupTriggers
Triggers		 Triggers that will close the quota group if hit.
SurveyInvitations
Collection of QuotaGroupSurveyInvitation 		Survey Invitation localized resources Currently the two cultures supported are en-us and fr-ca

Example Request Data

{
  "ProjectGuid": "01a915a7-d8ca-40c1-a5ea-1635f4162fce",
  "QuotaGroupGuid": "67d6d406-19f7-4d0a-828f-c4e6649b3671",
  "QuotaGroupName": "sample string 3",
  "IsOpen": true,
  "RequestedCompletes": 1,
  "BidResponseRate": 1.0,
  "IncidenceRate": 1.0,
  "AllowDynamicSurveys": true,
  "AllowExternalSuppliers": true,
  "Demographics": [
    {
      "DemographicGuid": "49921b4d-e799-4385-b20c-f36343262e31",
      "Answers": [
        {
          "AnswerGuid": "114d98be-cddb-4764-803b-809ee86b08d6"
        },
        {
          "AnswerGuid": "114d98be-cddb-4764-803b-809ee86b08d6"
        }
      ]
    },
    {
      "DemographicGuid": "49921b4d-e799-4385-b20c-f36343262e31",
      "Answers": [
        {
          "AnswerGuid": "114d98be-cddb-4764-803b-809ee86b08d6"
        },
        {
          "AnswerGuid": "114d98be-cddb-4764-803b-809ee86b08d6"
        }
      ]
    }
  ],
  "QuotaGroupTriggers": {
    "StartCap": 1,
    "CompleteCap": 1,
    "OverQuotaCap": 1,
    "TerminateCap": 1
  },
  "SurveyInvitations": [
    {
      "Culture": "sample string 1",
      "EmailInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      },
      "EmailReInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      }
    },
    {
      "Culture": "sample string 1",
      "EmailInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      },
      "EmailReInvitation": {
        "Subject": "sample string 1",
        "Body": "sample string 2"
      }
    }
  ]
}

Response Description

QuotaGroupGuid
globally unique identifier		 ClearVoice's unique identifier for a quota group.

Example Response

{
  "QuotaGroupGuid": "a40e4337-2d80-4e07-b787-0810e41acad8"
}