Create Invitation

Deprecated

POST

https://api.cloudflare.com/client/v4/organizations/{organization_identifier}/invites

Last modified:2022-12-16 13:48:34

Invite a User to become a Member of an Organization.

Request

Path Params

organization_identifier

string

required

Body Params application/json

auto_accept

boolean

optional

When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.

Default:

false

Example:

true

invited_member_email

string

required

Email address of the user to add to the organization.

<= 90 characters

Example:

user@example.com

roles

array [object]

required

Array of Roles associated with the invited user.

Example:

[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}]

Example

{
    "auto_accept": true,
    "invited_member_email": "user@example.com",
    "roles": [
        {
            "id": "5a7805061c76ada191ed06f989cc3dac"
        },
        {
            "id": "9a7806061c88ada191ed06f989cc3dac"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/organizations//invites' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auto_accept": true,
    "invited_member_email": "user@example.com",
    "roles": [
        {
            "id": "5a7805061c76ada191ed06f989cc3dac"
        },
        {
            "id": "9a7806061c88ada191ed06f989cc3dac"
        }
    ]
}'

Responses

🟢200Create Invitation response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Create Invitation response failure

Modified at 2022-12-16 13:48:34

List Invitations

Cancel Invitation