Skip to content

Job tags

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

Job tags are custom key-value pairs that your application can attach to each job request in the job's payload.tags property. Modigie returns these tags as is in all job responses.

You can use job tags for analytical or operational purposes.

Schema

payload.tags is an optional and nullable property containing an array of JobV2Tag objects.

Each tag object has two required properties, as described below:

name
The name of this custom tag. This is a required string value between 1 and 256 characters.
value
The value of this custom tag. This is a required string value between 1 and 1,024 characters.

Example

job-request.json
{
  "payload": {
    "tags": [
      {
        "name": "campaign",
        "value": "2025-09-OUT"
      },
      {
        "name": "billing",
        "value": "00427"
      }
    ],
    ...
  },
  ...
}

In every response message for this job request, Modigie will return the list of tags as provided by your application in the job request.

job-response.json
{
  "payload": {
    "tags": [
      {
        "name": "campaign",
        "value": "2025-09-OUT"
      },
      {
        "name": "billing",
        "value": "00427"
      }
    ],
    ...
  },
  ...
}

Schema: JobV2Tag