apicheats.dev github/llms.txt Raw .md
POST

POST /orgs/{org}/campaigns — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Create a campaign for an organization

Base URL
https://api.github.com
Auth
Authorization: Bearer <GITHUB_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 375 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X POST 'https://api.github.com/orgs/example-org/campaigns' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "name": "example-name",  "description": "example-description",  "ends_at": "2026-09-03T00:00:00Z"}'

Parameters

Name In Type Required Description
org path string Yes The organization name. The name is not case sensitive.
name body string Yes The name of the campaign
description body string Yes A description for the campaign
managers body string[] No The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.
team_managers body string[] No The slugs of the teams to set as the campaign managers.
ends_at body string Yes The end date and time of the campaign. The date must be in the future.
contact_link body string No The contact link of the campaign. Must be a URI.
code_scanning_alerts body object[] No The code scanning alerts to include in this campaign
generate_issues body boolean No If true, will automatically generate issues for the campaign. The default is false.

Response 200 OK

{
  "number": 0,
  "created_at": "2026-09-03T00:00:00Z",
  "updated_at": "2026-09-03T00:00:00Z",
  "name": "string",
  "description": "string",
  "managers": [
    {
      "name": "string",
      "email": "string",
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": true,
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "user_view_type": "public"
    }
  ],
  "team_managers": [
    {
      "id": 0,
      "node_id": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "privacy": "string",
      "notification_setting": "string",
      "permission": "string",
      "permissions": {
        "pull": true,
        "triage": true,
        "push": true,
        "maintain": true,
        "admin": true
      },
      "url": "https://example.com",
      "html_url": "https://github.com/orgs/rails/teams/core",
      "members_url": "string",
      "repositories_url": "https://example.com",
      "type": "enterprise",
      "access_source": "direct",
      "organization_id": 37,
      "enterprise_id": 42,
      "parent": {
        "id": 1,
        "node_id": "MDQ6VGVhbTE=",
        "url": "https://api.github.com/organizations/1/team/1",
        "members_url": "https://api.github.com/organizations/1/team/1/members{/member}",
        "name": "Justice League",
        "description": "A great team.",
        "permission": "admin",
        "privacy": "closed",
        "notification_setting": "notifications_enabled",
        "html_url": "https://github.com/orgs/rails/teams/core",
        "repositories_url": "https://api.github.com/organizations/1/team/1/repos",
        "slug": "justice-league",
        "ldap_dn": "uid=example,ou=users,dc=github,dc=com",
        "type": "enterprise",
        "organization_id": 37,
        "enterprise_id": 42
      }
    }
  ],
  "published_at": "2026-09-03T00:00:00Z",
  "ends_at": "2026-09-03T00:00:00Z",
  "closed_at": "2026-09-03T00:00:00Z",
  "state": "open",
  "contact_link": "https://example.com",
  "alert_stats": {
    "open_count": 0,
    "closed_count": 0,
    "in_progress_count": 0
  }
}
Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.