BIbigchange
Jobs

Create a recurring series on a job

Changed on

Adds a recurring series to an existing job. (required scope jobs:write)

post/v1/jobs/{jobId}/recurrence

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobs/{jobId}/recurrence
  • Auth
    HTTP bearer

Path parameters

jobIdinteger required

The unique identifier of the job

Headers

Customer-Idinteger required

The customer identifier

Request body

cronExpressionstring required

A standard 5-field CRON expression (minute hour dayOfMonth month dayOfWeek) describing the recurrence schedule.<br/>Only a limited subset is supported: minute must be '0', month must be '', and at most one of dayOfMonth/dayOfWeek<br/>may be a specific value (the other must be '')

recurTo'unallocatedJobs' | 'resourceOnceScheduled'

Determines how future occurrences of a recurring job are resourced.<p>Possible values:</p><ul><li><b>unallocatedJobs</b>: Future occurrences are created as unallocated jobs.</li><li><b>resourceOnceScheduled</b>: Future occurrences keep the resource from the job that was scheduled once.</li></ul>

startDateAtstring date-time required

The date and time the recurrence series starts

endDateAtstring date-time nullable

The date the recurrence series stops. Must not be provided together with BigChange.BO.RestApi.Application.JobRecurrences.Models.CreateJobRecurrenceModel.OccurrenceCount

occurrenceCountinteger nullable

The number of occurrences after which the recurrence series stops. Must not be provided together with BigChange.BO.RestApi.Application.JobRecurrences.Models.CreateJobRecurrenceModel.EndDateAt

Example request

{
  "cronExpression": "0 9 * * 2",
  "recurTo": "unallocatedJobs",
  "startDateAt": "2026-09-01T09:00:00.0000000+00:00",
  "endDateAt": "2027-03-01T00:00:00.0000000+00:00",
  "occurrenceCount": 10
}

Response

Created

recurrenceIdinteger

The unique identifier of the newly created recurrence series

jobIdinteger

The unique identifier of the job the recurrence was created on

recurrenceTypestring

The recurrence pattern resolved from the CRON expression

cronExpressionstring

The CRON expression that was provided

startDateAtstring date-time

The date and time the recurrence series starts

endConditionstring

A description of when the recurrence series stops — an end date, a number of occurrences, or "None" if it recurs indefinitely

upcomingOccurrencesstring[]

The calculated schedule of upcoming occurrences, within the platform's configured "months ahead" window. This<br/>reflects the calculated schedule, not already-created job records

Example response

{
  "recurrenceId": 789012,
  "jobId": 123456,
  "recurrenceType": "Weekly",
  "cronExpression": "0 9 * * 2",
  "startDateAt": "2026-09-01T09:00:00.0000000+00:00",
  "endCondition": "None"
}

Changes