provider campaigns POST /orgs/{org}/campaigns
@utdk/github /orgs/{org}/campaigns
Create a campaign for an organization
Create a campaign for 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. Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included in the campaign.
org path required
The organization name. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

campaigns.createCampaign
POST/orgs/{org}/campaigns
Create a campaign for 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. Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included in the campaign.

Parameters

required

The organization name. The name is not case sensitive.

Input

required

The name of the campaign

required

A description for the campaign

The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.

The slugs of the teams to set as the campaign managers.

required

The end date and time of the campaign. The date must be in the future.

The contact link of the campaign. Must be a URI.

The code scanning alerts to include in this campaign

If true, will automatically generate issues for the campaign. The default is false.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.campaigns.createCampaign({
  "generate_issues": false
})