---
title: Update Membership
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Memberships](https://developers.cloudflare.com/api/typescript/resources/memberships)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Update Membership

client.memberships.update(stringmembershipID, MembershipUpdateParams { status } body, RequestOptionsoptions?): [MembershipUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/memberships#%28resource%29%20memberships%20%3E%20%28model%29%20membership%5Fupdate%5Fresponse%20%3E%20%28schema%29) { id, account, api\_access\_enabled, 4 more } 

PUT/memberships/{membership\_id}

Accept or reject this account invitation.

##### Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### Accepted Permissions (at least one required)

`Memberships Write`

##### ParametersExpand Collapse 

membershipID: string

Membership identifier tag.

maxLength32

body: MembershipUpdateParams { status } 

status: "accepted" | "rejected"

Whether to accept or reject this account invitation.

One of the following:

"accepted"

"rejected"

##### ReturnsExpand Collapse 

MembershipUpdateResponse { id, account, api\_access\_enabled, 4 more } 

id?: string

Membership identifier tag.

maxLength32

account?: [Account](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts%20%3E%20%28model%29%20account%20%3E%20%28schema%29) { id, name, type, 3 more } 

id: string

Identifier

maxLength32

minLength32

name: string

Account name

maxLength100

type: "standard" | "enterprise"

One of the following:

"standard"

"enterprise"

created\_on?: string

Timestamp for the creation of the account

formatdate-time

managed\_by?: ManagedBy { parent\_org\_id, parent\_org\_name } 

Parent container details

parent\_org\_id?: string

ID of the parent Organization, if one exists

maxLength32

parent\_org\_name?: string

Name of the parent Organization, if one exists

settings?: Settings { abuse\_contact\_email, enforce\_twofactor } 

Account settings

abuse\_contact\_email?: string

Sets an abuse contact email to notify for abuse reports.

enforce\_twofactor?: boolean

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

api\_access\_enabled?: boolean | null

Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

permissions?: Permissions { analytics, billing, cache\_purge, 9 more } 

All access permissions for the user at the account.

analytics?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

billing?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

cache\_purge?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

dns?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

dns\_records?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

lb?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

logs?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

organization?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

ssl?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

waf?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

zone\_settings?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

zones?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

read?: boolean

write?: boolean

policies?: Array<Policy\>

Access policy for the membership

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission\_groups?: Array<PermissionGroup\>

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta?: Meta { key, value } 

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource\_groups?: Array<ResourceGroup\>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

scope: Scope { key, objects } 

A scope is a combination of scope objects which provides additional context.

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

objects: Array<Object\>

A list of scope objects for additional context.

key: string

This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

meta?: Meta { key, value } 

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

roles?: Array<string\>

List of role names the membership has for this account.

status?: "accepted" | "pending" | "rejected"

Status of this membership.

One of the following:

"accepted"

"pending"

"rejected"

### Update Membership

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const membership = await client.memberships.update('4536bcfad5faccb111b47003c79917fa', {
  status: 'accepted',
});

console.log(membership.id);
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "account": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "Demo Account",
      "type": "standard",
      "created_on": "2014-03-01T12:21:02Z",
      "managed_by": {
        "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
        "parent_org_name": "Demo Parent Organization"
      },
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "enforce_twofactor": true
      }
    },
    "api_access_enabled": true,
    "permissions": {
      "analytics": {
        "read": true,
        "write": false
      },
      "billing": {
        "read": true,
        "write": false
      },
      "cache_purge": {
        "read": true,
        "write": false
      },
      "dns": {
        "read": true,
        "write": false
      },
      "dns_records": {
        "read": true,
        "write": false
      },
      "lb": {
        "read": true,
        "write": false
      },
      "logs": {
        "read": true,
        "write": false
      },
      "organization": {
        "read": true,
        "write": false
      },
      "ssl": {
        "read": true,
        "write": false
      },
      "waf": {
        "read": true,
        "write": false
      },
      "zone_settings": {
        "read": true,
        "write": false
      },
      "zones": {
        "read": true,
        "write": true
      }
    },
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "access": "allow",
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Magic Network Monitoring"
          }
        ],
        "resource_groups": [
          {
            "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
            "scope": {
              "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
              "objects": [
                {
                  "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                }
              ]
            },
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
          }
        ]
      }
    ],
    "roles": [
      "Account Administrator"
    ],
    "status": "accepted"
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "account": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "Demo Account",
      "type": "standard",
      "created_on": "2014-03-01T12:21:02Z",
      "managed_by": {
        "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
        "parent_org_name": "Demo Parent Organization"
      },
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "enforce_twofactor": true
      }
    },
    "api_access_enabled": true,
    "permissions": {
      "analytics": {
        "read": true,
        "write": false
      },
      "billing": {
        "read": true,
        "write": false
      },
      "cache_purge": {
        "read": true,
        "write": false
      },
      "dns": {
        "read": true,
        "write": false
      },
      "dns_records": {
        "read": true,
        "write": false
      },
      "lb": {
        "read": true,
        "write": false
      },
      "logs": {
        "read": true,
        "write": false
      },
      "organization": {
        "read": true,
        "write": false
      },
      "ssl": {
        "read": true,
        "write": false
      },
      "waf": {
        "read": true,
        "write": false
      },
      "zone_settings": {
        "read": true,
        "write": false
      },
      "zones": {
        "read": true,
        "write": true
      }
    },
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "access": "allow",
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Magic Network Monitoring"
          }
        ],
        "resource_groups": [
          {
            "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
            "scope": {
              "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
              "objects": [
                {
                  "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                }
              ]
            },
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
          }
        ]
      }
    ],
    "roles": [
      "Account Administrator"
    ],
    "status": "accepted"
  }
}
```