Home
Version 3
Organizations API

Organizations API

Update an Organization

PUT /v2/organizations/:guid

Fields

Name Description Default Valid Values Example Values
name The name of the organization
  • my-org-name
status Status of the organization
quota_definition_guid The guid of quota to associate with this organization
  • org-quota-def-guid
billing_enabled If billing is enabled for this organization

Parameters

Name Description Valid Values Example Values
guid The guid of the Organization

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NCIsImVtYWlsIjoiZW1haWwtMjE2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzZ9.2KD_G6uhNzXNtlYUz8Pjbr2kSHVKF8ktavmL80eNrGc
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

Route

PUT /v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a

Body

{
  "name": "New Organization Name",
  "quota_definition_guid": "cb038f73-e7fd-43f9-b40c-d859c0d938e0"
}

cURL

curl "https://api.[your-domain.com]/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "cb038f73-e7fd-43f9-b40c-d859c0d938e0"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4NCIsImVtYWlsIjoiZW1haWwtMjE2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTk5ODk5NzZ9.2KD_G6uhNzXNtlYUz8Pjbr2kSHVKF8ktavmL80eNrGc" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 93cf842d-6e8f-4081-a674-cc20726b9e90
Content-Length: 1340
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "26c4b647-2729-4b6e-a3f3-17c9a97e932a",
    "url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a",
    "created_at": "2014-12-24T01:39:36+00:00",
    "updated_at": "2014-12-24T01:39:36+00:00"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "cb038f73-e7fd-43f9-b40c-d859c0d938e0",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/cb038f73-e7fd-43f9-b40c-d859c0d938e0",
    "spaces_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/spaces",
    "domains_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/domains",
    "private_domains_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/private_domains",
    "users_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/users",
    "managers_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/managers",
    "billing_managers_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/billing_managers",
    "auditors_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/auditors",
    "app_events_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/app_events",
    "space_quota_definitions_url": "/v2/organizations/26c4b647-2729-4b6e-a3f3-17c9a97e932a/space_quota_definitions"
  }
}