Modify organization.

PUT/organizations/{organization_id}

Modify organization. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

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

Path ParametersExpand Collapse

organization_id: string

Body ParametersJSONExpand Collapse

parent: optional object { id, name }

id: string

profile: optional AccountProfile { business_address, business_email, business_name, 2 more }

business_address: string

business_email: string

business_name: string

business_phone: string

external_metadata: string

ReturnsExpand Collapse

errors: array of unknown

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: Organization { id, create_time, meta, 3 more }

References an Organization in the Cloudflare data model.

id: string

create_time: string

formatdate-time

meta: object { hierarchy_tags, managed_by, tenant_flags }

hierarchy_tags: optional array of string

Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return [rootTag, ...intermediateTags, parentTag, selfTag]. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy.

managed_by: optional string

tenant_flags: optional object { account_creation, account_deletion, account_migration, 4 more }

Enable features for Organizations.

account_creation: string

account_deletion: string

account_migration: string

account_mobility: string

enterprise_capability: string

member_management: string

sub_org_creation: string

parent: optional object { id, name }

id: string

profile: optional AccountProfile { business_address, business_email, business_name, 2 more }

business_address: string

business_email: string

business_name: string

business_phone: string

external_metadata: string

success: true

Modify organization.

curl https://api.cloudflare.com/client/v4/organizations/$ORGANIZATION_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "name": "name"
        }'

200 example

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "hierarchy_tags": [
        "string"
      ],
      "managed_by": "managed_by",
      "tenant_flags": {
        "account_creation": "account_creation",
        "account_deletion": "account_deletion",
        "account_migration": "account_migration",
        "account_mobility": "account_mobility",
        "enterprise_capability": "enterprise_capability",
        "member_management": "member_management",
        "sub_org_creation": "sub_org_creation"
      }
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "name": "name"
    },
    "profile": {
      "business_address": "business_address",
      "business_email": "business_email",
      "business_name": "business_name",
      "business_phone": "business_phone",
      "external_metadata": "external_metadata"
    }
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "hierarchy_tags": [
        "string"
      ],
      "managed_by": "managed_by",
      "tenant_flags": {
        "account_creation": "account_creation",
        "account_deletion": "account_deletion",
        "account_migration": "account_migration",
        "account_mobility": "account_mobility",
        "enterprise_capability": "enterprise_capability",
        "member_management": "member_management",
        "sub_org_creation": "sub_org_creation"
      }
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "name": "name"
    },
    "profile": {
      "business_address": "business_address",
      "business_email": "business_email",
      "business_name": "business_name",
      "business_phone": "business_phone",
      "external_metadata": "external_metadata"
    }
  },
  "success": true
}