PATCH /orgs/{org}/campaigns/{campaign_number}
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.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
campaign_number |
Integer | Yes |
The campaign number. |
org |
String | Yes |
The organization name. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
The name of the campaign |
managers[] |
Array | No |
The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. |
description |
String | No |
A description for the campaign |
contact_link |
String | No |
The contact link of the campaign. Must be a URI. |
state |
String | No |
Indicates whether a campaign is open or closed Possible values:
|
team_managers[] |
Array | No |
The slugs of the teams to set as the campaign managers. |
ends_at |
String | No |
The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.