| Endpoint | Description |
|---|---|
| POST W9FormPostback/W9FormSubmitted | PostBack method for setting w9 form status after submitting |
| Endpoint | Description |
|---|---|
| GET CintSurveyPostback/RewardMemberForCintSurvey?mg={mg}&project={project}&payout={payout}&uniqueStartGuid={uniqueStartGuid}&lastProjectId={lastProjectId} | Adds a reward info regarding params provided by Cint API |
| GET CintSurveyPostback/RewardMemberForNonSuccessCintSurvey?mg={mg}&project={project}&surveyStatus={surveyStatus}&uniqueStartGuid={uniqueStartGuid}&lastProjectId={lastProjectId} | Adds a reward info for a non success survey regarding params provided by Cint API |
| Endpoint | Description |
|---|---|
| GET CintSurvey/GetCintStudies?ExternalMemberId={ExternalMemberId}&IpAddress={IpAddress} | Returns list of surveys provided by Cint API |
| GET CintSurvey/GetCintProjectCompletes?StartDate={StartDate} | Returns list of cint project completes that have happened since start date. |
API for managing Members
| Endpoint | Description |
|---|---|
| GET Member/IsMemberFraud?MemberId={MemberId} | |
| GET Member/IsMemberDoi?MemberId={MemberId} | |
| GET Member/GetExternalUserReferrals?ExternalMemberId={ExternalMemberId} | Get user's external referrals by external member id. |
| POST Member/CreateExternalMember | Creates External Member in our system and returns member GUID and Primary Key |
| POST Member/UpdateMember | Updates a member in our system using the supplied data. |
| GET Member/GetMemberFailedValidations?MemberGuid={MemberGuid} | Returns results of comparing the members given answers to Address, Education, Income, and Residence to third party data. party data. |
| POST Member/SaveMemberFailedValidationExplanations | Endpoint for saving member explanations for failed third party validations, saying that the data has changed recently or not and allowing for Admin review of the given answers. |
| POST Member/VerifyEmail | Endpoint for verifying that an email is valid. |
| POST Member/AddMemberVerification | Adds a verification for the given member. |
| POST Member/UpdateMemberSMSInvitationsOptIn | Updates the sms invitations opt in decision for the given member. |
| POST Member/AddMemberDataPrivacyRequest | Adds a data privacy request for the given member if they live in California |
| POST Member/ConfirmMemberDataPrivacyRequest | Marks the provided data privacy request as confirmed by member and updates the member record accordingly |
| POST Member/CancelMemberDataPrivacyRequest | Marks the provided data privacy request as cancelled by member |
| GET Member/GetDataPrivacyRequestStatus?DataPrivacyRequestId={DataPrivacyRequestId} | Gets the status of the requested data privacy request, if it exists. |
| POST Member/CreateMemberMobileDevice | Creates a mobile device for the provided member |
| PUT Member/UpdateMemberMobileDevice | Updates the ArePushNotificationsEnabled configuration for a mobile device based on the provided member id and device id |
| DELETE Member/DeleteMemberMobileDevice | Deletes a mobile device based on the provided memberId and deviceId |
| GET Member/DoesMemberExistWithEmail?EmailAddress={EmailAddress} | Checks if the member exist by the email address. |
| POST Member/CheckMembersSmsDeliverability | Check Members Sms Deliverability by member id |
| POST Member/DismissSurvey | Dismiss external survey by external project id |
| POST Member/UndismissSurvey | Dismiss external survey by external project id |
| POST Member/SendExternalMemberReferral | |
| POST Member/ReSendExternalMemberReferral | Resend External Member Referral by emailAddress. |
| POST Member/CreateCommunityMember |
API providing access to our Survey Inventory (Version 2)
| Endpoint | Description |
|---|---|
| GET SurveyInventory/GetSurveysForExternalMember?ExternalMemberId={ExternalMemberId} | Returns listing of surveys that matches the supplied members demographics. |
Handles read operations related to Organizations.
| Endpoint | Description |
|---|---|
| GET Org/GetVendors | Retrieves a listing of available vendors |
API for managing members.
| Endpoint | Description |
|---|---|
| GET Member/GetByExternalMemberId?ExternalMemberId={ExternalMemberId} | Returns a Member by the ExternalMemberId. |
| GET Member/GetByMemberGuid?MemberGuid={MemberGuid} | Returns a Member by the MemberId |
| GET Member/GetOpenProjectInfoByExternalMemberId?ExternalMemberId={ExternalMemberId} | Returns information needed for external panels to show invitations to CV projects |
| GET Member/GetRewardInformationByUserInvitationGuid?UserInvitationGuid={UserInvitationGuid} | Returns information needed for external panels to show invitations to CV projects |
| POST Member/CreateExternalMember | Creates a External Member in our system. |
| POST Member/CreateMember | Creates a member in our system. |
| POST Member/UpdateMember | Updates a member in our system using the supplied data. |
| POST Member/SaveDemographicAnswers | Allows for a members Answers to a Demographic to be saved. All previous answers for a member for the supplied demographics will be deleted before the new Answers are saved. |
| GET Member/GetDemographicAnswers?MemberGuid={MemberGuid}&ExternalMemberId={ExternalMemberId} | Retrieves a listing of the demographics for a member. |
| GET Member/GetUserInvitationInformation?UserInvitationGuid={UserInvitationGuid} | Returns information needed for external panels to show invitations to CV projects |
| POST Member/GetMemberIdsByExternalIds | Retrieves the mapping to member IDs by the member guid |
Handles all CRUD operations related to QuotaGroups.
| Endpoint | Description |
|---|---|
| POST QuotaGroups/CreateQuotaGroups | Creates multiple demographic quota groups on a single project. This is an all or nothing operation. |
| POST QuotaGroups/CreateQuotaGroup | Creates a demographic quota group on a single project. |
| POST QuotaGroups/UpdateQuotaGroup | Updates the demographic quota group specified by the QuotaGroupGuid parameter. |
| POST QuotaGroups/CreateVendorQuotaGroups | Creates multiple vendor quota groups on a single project. This is an all or nothing operation. |
| POST QuotaGroups/UpdateVendorQuotaGroup | Updates the vendor quota group specified by the QuotaGroupGuid parameter. |
Handles all CRUD operations related to Projects.
| Endpoint | Description |
|---|---|
| POST Projects/CreateProject | Creates a project specified by the request parameter. |
| POST Projects/UpdateProject | Updates the project specified by the ProjectGuid parameter. |
| POST Projects/UpdateToInvoicedByCakeOfferIds | Updates the ROI and Demographic Project Statuses to Invoiced |
API providing access to our Survey Inventory
| Endpoint | Description |
|---|---|
| GET SurveyInventory/GetSurveysForExternalMember?ExternalMemberId={ExternalMemberId} | Returns listing of surveys that matches the supplied members demographics. |
Specify the API login credentials in the request headers.
Authorization: Basic {Username}:{Password}
Example:
Authorization: Basic 5A3EDF8D-DEEA-43A4-8152-618440A87013:DF3BDDB4-4FCB-49A3-ABEC-FEEDA1F68E04
Request Content for a POST: Content-Type: application/json or Content-Type: application/xml
Response Content: Accept: application/json or Accept: application/xml
The version of the API you would like to use can be specified via the URI as shown below.
Example:
http://api.clearvoicesurveys.com/api/v1/SurveyInventory/GetSurveysForExtMember?ExternalMemberId=BBBB