BIbigchange
Jobs

Applies a job flag to all jobs within the specified group

Changed on

Apply a job flag to all jobs within the specified group (required scope jobs:write)

post/v1/jobGroups/{groupId}/jobFlags

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobGroups/{groupId}/jobFlags
  • Auth
    HTTP bearer

Path parameters

groupIdinteger required

The job group id

Headers

Customer-Idinteger required

The customer identifier

Request body

flagIdinteger required

The unique identifier of the flag to apply

ownerstring

User email or ID who owns the flag

commentsstring nullable

Additional context for the flag

Example request

{
  "flagId": 12345,
  "owner": "john.doe@example.com",
  "comments": "Requires special attention"
}

Response

Created

groupIdinteger

The ID of the job group

jobsFlaggedCountinteger

The number of jobs to which the flag was applied

Changes