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:

Team
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": "bad_request",
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
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "error": {
5
      "type": "object",
6
      "properties": {
7
        "id": {
8
          "type": "string"
9
        },
10
        "code": {
11
          "type": "string",
12
          "enum": [
13
            "bad_request",
14
            "forbidden",
15
            "internal_server_error",
16
            "not_found",
17
            "payment_required",
18
            "rate_limit_exceeded",
19
            "request_timeout",
20
            "request_too_large",
21
            "unauthorized",
22
            "validation_failed",
23
            "agentic_credential_not_found",
24
            "backup_unsupported",
25
            "branch_admin_required",
26
            "compute_build_context_too_large",
27
            "compute_build_in_progress",
28
            "compute_deploy_rate_limit_exceeded",
29
            "compute_instance_limit_exceeded",
30
            "compute_instance_not_found",
31
            "compute_not_enabled",
32
            "compute_request_rejected",
33
            "compute_unavailable",
34
            "notebook_cell_duplicate",
35
            "notebook_cell_unknown",
36
            "notebook_disabled",
37
            "notebook_not_found",
38
            "notebook_sort_invalid",
39
            "organization_invitation_email_delivery_failed",
40
            "organization_invitations_partially_failed",
41
            "organization_role_name_invalid",
42
            "organization_role_not_entitled",
43
            "pagination_cursor_invalid",
44
            "project_branch_resync_unsupported",
45
            "project_not_found",
46
            "project_privatelink_disabled",
47
            "project_transfer_disabled",
48
            "delivery_not_found",
49
            "endpoint_disabled",
50
            "endpoint_event_type_not_subscribed",
51
            "endpoint_not_found",
52
            "endpoint_url_unresolvable",
53
            "webhooks_access_disabled"
54
          ]
55
        },
56
        "message": {
57
          "type": "string"
58
        },
59
        "description": {
60
          "type": "string"
61
        },
62
        "links": {
63
          "type": "object",
64
          "additionalProperties": {
65
            "type": "object",
66
            "properties": {
67
              "href": {
68
                "type": "string"
69
              },
70
              "rel": {
71
                "type": "string"
72
              },
73
              "title": {
74
                "type": "string"
75
              },
76
              "type": {
77
                "type": "string"
78
              },
79
              "describedby": {
80
                "type": "string"
81
              },
82
              "meta": {
83
                "type": "object",
84
                "additionalProperties": {}
85
              }
86
            },
87
            "required": [
88
              "href"
89
            ]
90
          }
91
        },
92
        "meta": {
93
          "type": "object",
94
          "additionalProperties": {}
95
        },
96
        "issues": {
97
          "type": "array",
98
          "items": {
99
            "type": "object",
100
            "properties": {
101
              "id": {
102
                "type": "string"
103
              },
104
              "code": {
105
                "type": "string"
106
              },
107
              "message": {
108
                "type": "string"
109
              },
110
              "description": {
111
                "type": "string"
112
              },
113
              "links": {
114
                "type": "object",
115
                "additionalProperties": {
116
                  "type": "object",
117
                  "properties": {
118
                    "href": {
119
                      "type": "string"
120
                    },
121
                    "rel": {
122
                      "type": "string"
123
                    },
124
                    "title": {
125
                      "type": "string"
126
                    },
127
                    "type": {
128
                      "type": "string"
129
                    },
130
                    "describedby": {
131
                      "type": "string"
132
                    },
133
                    "meta": {
134
                      "type": "object",
135
                      "additionalProperties": {}
136
                    }
137
                  },
138
                  "required": [
139
                    "href"
140
                  ]
141
                }
142
              },
143
              "meta": {
144
                "type": "object",
145
                "properties": {
146
                  "email": {
147
                    "type": "string",
148
                    "format": "email",
149
                    "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
150
                    "description": "Email address of the invitation receipient.",
151
                    "example": "hello@example.com"
152
                  }
153
                },
154
                "required": [
155
                  "email"
156
                ]
157
              }
158
            },
159
            "required": [
160
              "code",
161
              "message",
162
              "meta"
163
            ]
164
          }
165
        }
166
      },
167
      "required": [
168
        "code",
169
        "message"
170
      ]
171
    },
172
    "data": {
173
      "type": "array",
174
      "items": {
175
        "type": "object",
176
        "properties": {
177
          "type": {
178
            "type": "string",
179
            "description": "Resource type.",
180
            "enum": [
181
              "organization_invitation"
182
            ]
183
          },
184
          "attributes": {
185
            "type": "object",
186
            "properties": {
187
              "email": {
188
                "type": "string",
189
                "format": "email",
190
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
191
                "description": "Email address of the invitation receipient.",
192
                "example": "hello@example.com"
193
              }
194
            },
195
            "required": [
196
              "email"
197
            ]
198
          }
199
        },
200
        "required": [
201
          "type",
202
          "attributes"
203
        ]
204
      }
205
    }
206
  },
207
  "required": [
208
    "data"
209
  ]
210
}