GitHub: Campaigns schemas
1 GitHub schema with complete fields and constraints.
← Campaigns operations · All schemas
Update a campaign — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The campaign metadata and alert stats. |
alert_stats | object | Optional | Additional keys: not allowed |
alert_stats.closed_count | JSON | Required within parent | |
alert_stats.closed_count (anyOf 1) | integer | Alternative | The number of closed alerts |
alert_stats.closed_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
alert_stats.in_progress_count | JSON | Required within parent | |
alert_stats.in_progress_count (anyOf 1) | integer | Alternative | The number of in-progress alerts |
alert_stats.in_progress_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
alert_stats.open_count | JSON | Required within parent | |
alert_stats.open_count (anyOf 1) | integer | Alternative | The number of open alerts |
alert_stats.open_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
closed_at | JSON | Optional | |
closed_at (anyOf 1) | string | Alternative | The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. Format: date-time |
closed_at (anyOf 2) | null | Alternative | |
contact_link | JSON | Required within parent | |
contact_link (anyOf 1) | string | Alternative | The contact link of the campaign. Format: uri |
contact_link (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time |
description | string | Required within parent | The campaign description |
ends_at | string | Required within parent | The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time |
managers | array | Required within parent | The campaign managers |
managers[] | Model | Each item | Expand List users — response body — item |
name | string | Optional | The campaign name |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | The number of the newly created campaign |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
published_at | string | Optional | The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time |
state | string | Required within parent | Indicates whether a campaign is open or closed Known values: open, closed |
team_managers | array | Optional | The campaign team managers |
team_managers[] | Model | Each item | Expand List teams — response body — item |
updated_at | string | Required within parent | The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Format: date-time |
Referenced models: List users — response body — item, List teams — response body — item