Update organization

client.Organizations.Update(ctx, organizationID, body) (*Organization, error)

PUT/organizations/{organization_id}

Update an organization’s name. Supplying parent_id verifies the current parent; this endpoint cannot move an organization. Organization names are limited to 65 UTF-8 bytes.

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

ParametersExpand Collapse

organizationID string

body OrganizationUpdateParams

Name param.Field[string]Optional

The Organization’s display name, limited to 65 UTF-8 bytes. An omitted, empty, or unchanged value is a no-op.

ParentID param.Field[string]Optional

The current parent Organization ID. A different value is rejected; this endpoint cannot move an Organization.

ReturnsExpand Collapse

type Organization struct{…}

References an Organization in the Cloudflare data model.

ID string

CreateTime Time

formatdate-time

Meta OrganizationMeta

AreChildAccountsAccessibleByOrgMembers boolOptional

HierarchyTags []stringOptional

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.

ManagedBy stringOptional

TenantFlags OrganizationMetaTenantFlagsOptional

Enable features for Organizations.

AccountCreation string

AccountCreationAppliesTenantDefaults string

AccountDeletion string

AccountMigration string

AccountMobility string

EnterpriseCapability string

MemberManagement string

SubOrgCreation string

TenantType stringOptional

Name string

Parent OrganizationParentOptional

ID string

Name string

Profile AccountProfileOptional

BusinessAddress string

BusinessEmail string

BusinessName string

BusinessPhone string

ExternalMetadata string

Update organization

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/organizations"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  organization, err := client.Organizations.Update(
    context.TODO(),
    "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    organizations.OrganizationUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", organization.ID)
}

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "are_child_accounts_accessible_by_org_members": true,
      "hierarchy_tags": [
        "string"
      ],
      "managed_by": "managed_by",
      "tenant_flags": {
        "account_creation": "account_creation",
        "account_creation_applies_tenant_defaults": "account_creation_applies_tenant_defaults",
        "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"
      },
      "tenant_type": "tenant_type"
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
      "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

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "are_child_accounts_accessible_by_org_members": true,
      "hierarchy_tags": [
        "string"
      ],
      "managed_by": "managed_by",
      "tenant_flags": {
        "account_creation": "account_creation",
        "account_creation_applies_tenant_defaults": "account_creation_applies_tenant_defaults",
        "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"
      },
      "tenant_type": "tenant_type"
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
      "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
}