Creates a demographic quota group on a single project.

Endpoint URL

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

Parameters

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

Required
QuotaGroup
QuotaGroup
Representation of the quota group to be created.

Example Request Data

{
  "ProjectGuid": "0315df75-3543-4733-bd62-9eca82a7e2e9",
  "QuotaGroup": {
    "Demographics": [
      {
        "DemographicGuid": "f3df30f5-096b-4293-815f-117dd34fd453",
        "Answers": [
          {
            "AnswerGuid": "e97a33ea-99b7-4f3a-86eb-e2dea032f58e"
          },
          {
            "AnswerGuid": "e97a33ea-99b7-4f3a-86eb-e2dea032f58e"
          }
        ]
      },
      {
        "DemographicGuid": "f3df30f5-096b-4293-815f-117dd34fd453",
        "Answers": [
          {
            "AnswerGuid": "e97a33ea-99b7-4f3a-86eb-e2dea032f58e"
          },
          {
            "AnswerGuid": "e97a33ea-99b7-4f3a-86eb-e2dea032f58e"
          }
        ]
      }
    ],
    "AllowDynamicSurveys": true,
    "AllowExternalSuppliers": true,
    "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"
        }
      }
    ],
    "QuotaGroupName": "sample string 1",
    "RequestedCompletes": 2,
    "BidResponseRate": 3.0,
    "IncidenceRate": 4.0,
    "QuotaGroupTriggers": {
      "StartCap": 1,
      "CompleteCap": 1,
      "OverQuotaCap": 1,
      "TerminateCap": 1
    }
  }
}

Response Description

CreatedQuotaGroup
CreateQuotaGroupResponseModel
Response for the creation of a quota group.

Example Response

{
  "CreatedQuotaGroup": {
    "ProjectGuid": "1751c6f0-b673-43da-b8ee-2c7a63fba4e0",
    "QuotaGroupGuid": "73df7c87-0cbb-4f14-8324-bff6f394cc11"
  }
}