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 an upload-by-file job status

This endpoint retrieves the status and details of a specific 'upload by file' job. After creating a job, you should poll this endpoint periodically until the `status` field changes from `Processing` to either `Completed` or `Failed` to get the final result.

📄️ Create a job to upload respondent IDs by file

This endpoint creates an asynchronous job to upload a file containing Respondent IDs (RSIDs) for recontact opportunities. The new IDs will be added to any existing ones for the specified Target Group.

📄️ Create a job to remove all recontact respondent IDs

This endpoint creates an asynchronous job to remove all stored Respondent IDs (RSIDs) recontact opportunities for the specified Target Group.

📄️ Get 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.

📄️ List recontact respondent IDs

This endpoint returns a paginated list of all Respondent IDs (RSIDs) eligible for recontact on this Target Group. Use the `start_after` parameter with the `next_cursor` value from a previous response to navigate through pages.

📄️ 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.