Sample - GitHub REST API
PATCH/orgs/{org}/campaigns/{campaign_number}

Update a campaign

Updates a campaign in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 7 body fields
orgstringrequired
The organization name. The name is not case sensitive.
campaign_numberintegerrequired
The campaign number.
namestringoptional
The name of the campaign
descriptionstringoptional
A description for the campaign
managersarray<string>optional
The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.
team_managersarray<string>optional
The slugs of the teams to set as the campaign managers.
ends_atstringoptional
The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
contact_linkstringoptional
The contact link of the campaign. Must be a URI.
statestringoptional
Indicates whether a campaign is open or closed
Allowed:openclosed

5 status codes
200Response
numberintegerrequired
The number of the newly created campaign
created_atstringrequired
The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
updated_atstringrequired
The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
namestringoptional
The campaign name
descriptionstringrequired
The campaign description
managersarray<SimpleUser>required
The campaign managers
team_managersarray<Team>optional
The campaign team managers
published_atstringoptional
The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
ends_atstringrequired
The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
closed_atstringoptional
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.
statestringrequired
Indicates whether a campaign is open or closed
Allowed:openclosed
contact_linkstringrequired
The contact link of the campaign.
alert_statsobjectoptional
400Bad Request
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Unprocessable Entity
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
503Service unavailable
codestringoptional
messagestringoptional
documentation_urlstringoptional

Error handling

A 400 is returned: Bad Request. A 404 is returned: Resource not found. A 422 is returned: Unprocessable Entity. A 503 is returned: Service unavailable.