Updates the vendor quota group specified by the QuotaGroupGuid parameter.

Endpoint URL

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

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		 The name of the quota group to create.

String length: inclusive between 2 and 100
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.

Range: inclusive between 0 and 100
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.
VendorCPC
decimal number		 Vendor cost associated to the Clearvoice org in which a Survey is completed
VendorGuid
globally unique identifier		 Vendor Associated with this Quota Group
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
SelectedCountries
Collection of string 		Represents the countries where the Survey is available.
Members
Collection of VendorQuotaGroupMember 		Represents the Member ID's uploaded by the Vendor.
QuotaGroupTriggers
Triggers		 Triggers that will close the quota group if hit.
SuccessPostBackUrl
string		 PostBack URL which when fired creates a conversion.
TerminatePostBackUrl
string		 PostBack URL which when fired determines that a survey has been terminated.
OverQuotaPostBackUrl
string		 PostBack URL which when fired determines that a survey has been closed since it has met the required number of completes.
RejectQuotaPostBackUrl
string		 PostBack URL which when fired determines that the user has been rejected
DuplicatePostBackUrl
string		 PostBack URL which when fired determines that the Survey has already been taken

Example Request Data

{
  "ProjectGuid": "fbba2b7a-cac7-48e2-95ea-757da648fb14",
  "QuotaGroupGuid": "81f0a388-6586-4b7c-9ba5-34d3be19363b",
  "QuotaGroupName": "sample string 3",
  "RequestedCompletes": 1,
  "BidResponseRate": 1.0,
  "IncidenceRate": 1.0,
  "VendorCPC": 1.0,
  "VendorGuid": "64170845-ad8f-4ad1-bc64-345640c6a418",
  "IsOpen": true,
  "SelectedCountries": [
    "sample string 1",
    "sample string 2"
  ],
  "Members": [
    {
      "MemberId": "sample string 1",
      "Url": "sample string 2"
    },
    {
      "MemberId": "sample string 1",
      "Url": "sample string 2"
    }
  ],
  "QuotaGroupTriggers": {
    "StartCap": 1,
    "CompleteCap": 1,
    "OverQuotaCap": 1,
    "TerminateCap": 1
  },
  "SuccessPostBackUrl": "sample string 4",
  "TerminatePostBackUrl": "sample string 5",
  "OverQuotaPostBackUrl": "sample string 6",
  "RejectQuotaPostBackUrl": "sample string 7",
  "DuplicatePostBackUrl": "sample string 8"
}

Response Description

ProjectGuid
globally unique identifier		 The ProjectGuid for the project the quota group was created in.
QuotaGroupGuid
globally unique identifier		 The QuotaGroupGuid of the quota group that was created.
CVSSurveyInvitationUrl
string		 The CVS Survey Invitation Url for this quota group

Example Response

{
  "ProjectGuid": "2cc35269-fe2c-494c-b767-69cffe522ce5",
  "QuotaGroupGuid": "e6063329-fe80-475c-84a5-5a8d9b8849c4",
  "CVSSurveyInvitationUrl": "sample string 3"
}