Fielding
Create, update and obtain Target Group Fielding runs and Fielding Assistant assignments. This is critical for launching, scheduling and completing Target Groups.
📄️ Retrieves a fielding run
Fetches the details of a fielding run.
📄️ Retrieves a `launch fielding run from draft` job
Returns a `launch fielding run from draft` job.
📄️ Complete a fielding run
Completes a fielding run and sets the fielding run status to complete, regardless if its goals or end date has been reached. It is recommended to set Content-Length to zero when calling out to this endpoint.
📄️ Pause a fielding run
Pauses a live fielding run and sets the fielding run status to paused. To resume a fielding run and to set it live again, use the /resume API. It is recommended to set Content-Length to zero when calling out to this endpoint.
📄️ Retrieves a `schedule fielding run from draft` job
Returns a `schedule fielding run from draft` job.
📄️ Updates a fielding run
Update a specific fielding run of a target group.
📄️ Creates a `launch fielding run from draft` job
Creates a job that transitions a draft target group to live, able to collect completes on the Exchange. The process is asynchronous, so success on this call just means a job has been created. If validations are successful the target group will be set to live. In order to check on the job you will need to retrieve the job status, please refer to the ['Returns a launch fielding run from draft job' endpoint](#tag/Fielding/operation/get_launch_fielding_run_from_draft_job)
📄️ Relaunch a fielding run
Relaunches a completed fielding run and sets the fielding run status to live again, if its goals and end date have not been reached yet. It is recommended to set Content-Length to zero when calling out to this endpoint.
📄️ Creates a `schedule fielding run from draft` job
Returns location to the created schedule fielding run from draft job.
📄️ Get fielding runs by target group id
Fetches the fielding runs for a given target group.
📄️ Launches a fielding run now
Update the fielding run's fielding period to start now and launch the fielding run. Both start and end time of the fielding run will be updated.
📄️ Resume a fielding run
Resumes a paused fielding run and sets the fielding run live again, if its goals and end date have not been reached. It is recommended to set Content-Length to zero when calling out to this endpoint.