Sign in

v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
Job

Creates a new job from a job definition and audience.

If the audience is not already recruiting, recruiting is started automatically. The RecruitingStarted field indicates whether this happened.

post/job

Request body

jobDefinitionIdstring required

The id of the job definition to use.

audienceIdstring required

The id of the audience to target.

revisionNumberinteger nullable

The revision number to use. If not specified, the latest revision will be used.

namestring nullable

The name of the job. If not specified, defaults to "{definition name}:{revision number}".

priorityinteger nullable

The priority of the job. Higher values mean higher priority. When omitted, a per-owner default is applied server-side. A requested value is capped for non-admin customers.

precedingJobIdstring nullable

Optional id of a job that must finish before this job starts. When set, this job is queued until the preceding job completes or fails.

notifyOwnerOnCompletionboolean

Whether the job's owner should be emailed when the job completes. Defaults to false.

checkForExplicitContentboolean nullable

Whether Rapidata's explicit-content check should run for this job. Leave null to use the default for the caller's account. Set true to force the check on. Set false to skip it — honored only when the account is permitted to skip; otherwise the check still runs and ContentCheckSkipDenied is set on the response.

Response

OK

jobIdstring required

The id of the created job.

recruitingStartedboolean required

Whether recruiting was automatically started for the audience.

contentCheckSkipDeniedboolean

True when the caller asked to skip the explicit-content check but is not permitted to; the check runs regardless. Advisory — the job is created and runs either way.