Create organization invitations | Management API Reference

Creates organization invitations

post/v2/organizations/{slug}/members/invitations

Creates member invitations for an organization. Each invitation can have different role and project scope settings.

OAuth scopes

organizations:write

This endpoint is only available on the following plans:

Enterprise

The fine-grained token must include the following permissions to access this endpoint:

members_write

Path parameters

slug
Required
string
Organization slug

Body

data
Required
Array<object>

Response codes

Response (201)

1
{
2
  "error": {
3
    "id": "lorem",
4
    "code": "lorem",
5
    "message": "lorem",
6
    "description": "lorem",
7
    "links": {
8
      "property1": {
9
        "href": "lorem",
10
        "rel": "lorem",
11
        "title": "lorem",
12
        "type": "lorem",
13
        "describedby": "lorem",
14
        "meta": {
15
          "property1": null,
16
          "property2": null
17
        }
18
      },
19
      "property2": {
20
        "href": "lorem",
21
        "rel": "lorem",
22
        "title": "lorem",
23
        "type": "lorem",
24
        "describedby": "lorem",
25
        "meta": {
26
          "property1": null,
27
          "property2": null
28
        }
29
      }
30
    },
31
    "meta": {
32
      "property1": null,
33
      "property2": null
34
    },
35
    "issues": [
36
      {
37
        "id": "lorem",
38
        "code": "lorem",
39
        "message": "lorem",
40
        "description": "lorem",
41
        "links": {
42
          "property1": {
43
            "href": "lorem",
44
            "rel": "lorem",
45
            "title": "lorem",
46
            "type": "lorem",
47
            "describedby": "lorem",
48
            "meta": {
49
              "property1": null,
50
              "property2": null
51
            }
52
          },
53
          "property2": {
54
            "href": "lorem",
55
            "rel": "lorem",
56
            "title": "lorem",
57
            "type": "lorem",
58
            "describedby": "lorem",
59
            "meta": {
60
              "property1": null,
61
              "property2": null
62
            }
63
          }
64
        },
65
        "meta": {
66
          "email": "hello@example.com"
67
        }
68
      }
69
    ]
70
  },
71
  "data": [
72
    {
73
      "type": "organization_invitation",
74
      "attributes": {
75
        "email": "hello@example.com"
76
      }
77
    }
78
  ]
79
}