Recontacts

Create, update, list and delete recontacts for a target group. Recontacts allow only specific respondents to enter your survey and are part of a larger workflow that needs specific configurations across other endpoints.

📄️ Get information on an upload Recontact opportunities by file job

Gets information on a upload Respondent ID (RSID) recontact opportunities by file job. This should be checked regularly for progress and status. Execution time can vary but adding 10,000 identifiers could take between 3 and 5 minutes.

📄️ Create a job to upload Recontact opportunities by file

Creates a job to upload new Respondent ID (RSIDs) Recontact opportunities by file for the specified Target Group ID. The new IDs will be added to the existing ones. The total number of IDs, both existing and new, must not exceed 100,000 IDs. This will return an identifier that can be used to retrieve the job execution information, including the status. Only one job can run at a time for a Target Group. If another job is already running before the endpoint is called for the same Target Group, a conflict response will be returned. The file must be in CSV or TXT format, without a header row. Each line should contain a single identifier. Only one single file can be uploaded per job and the file size must be less than 5MB. While execution time may vary, storing 10,000 new respondents typically takes between 10 and 15 minutes.

📄️ Create a job to remove all the Recontact opportunities added to a Target Group

Creates a job to remove all the specified Respondent ID (RSID) Recontact opportunities added to a Target Group. This will return an identifier that can be used to retrieve the job execution information, including the status. Only one job can run at a time for a Target Group. If another job is already running before the endpoint is called for the same Target Group, a conflict response will be returned. While execution time may vary, removing 10,000 respondents typically takes between 3 and 5 minutes.

📄️ Retrieve recontact overview for a target group

This endpoint retrieves the total number of saved Respondent IDs that have an opportunity to enter the Target Group.

📄️ Gets a paginated list of Respondent IDs available for Recontact on a Target Group.

Gets a paginated list of Respondent IDs (RSIDs) who are eligable for a Recontact opportunity on a given Target Group.

📄️ Get information on a remove all Recontact opportunities job

Gets information on a specific remove all Respondent ID (RSID) Recontact opportunities job. This will remove all IDs from the Target Group and will prevent any more respondents entering your survey, or the work being launched or relaunched until more IDs are added. This should be checked regularly for progress and status. Execution time can vary but removing 10,000 identifiers could take between 3 and 5 minutes.