Add Member

POST

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/members

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

Add a user to the list of members for this account.

Request

Path Params

account_identifier

string

required

Body Params application/json

string

required

The contact email address of the user.

<= 90 characters

Example:

user@example.com

roles

array

required

Array of roles associated with this member.

status

optional

Allowed values:

acceptedpending

Default:

pending

Example

{
    "email": "user@example.com",
    "roles": [
        "3536bcfad5faccb999b47003c79917fb"
    ],
    "status": "pending"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/accounts//members' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "roles": [
        "3536bcfad5faccb999b47003c79917fb"
    ],
    "status": "pending"
}'

Responses

🟢200Add Member 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
}

🟢200Add Member response failure

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

List Members

Remove Member