Home
Version 3
Organizations API

Organizations API

Update an Organization

PUT /v2/organizations/:guid

Request

Route

PUT /v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf

Parameters

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

Body

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 
{
  "name": "New Organization Name",
  "quota_definition_guid": "6eb35a91-e814-405f-a3f7-ddd8d6f5aea1"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MiIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MzB9.dDE4h0RYlx-9-QQGjYYkmxpew--MBrgb5H2p5aejjU4
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "6eb35a91-e814-405f-a3f7-ddd8d6f5aea1"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MiIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MzB9.dDE4h0RYlx-9-QQGjYYkmxpew--MBrgb5H2p5aejjU4" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf",
    "url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf",
    "created_at": "2016-01-26T22:20:30Z",
    "updated_at": "2016-01-26T22:20:30Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "6eb35a91-e814-405f-a3f7-ddd8d6f5aea1",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/6eb35a91-e814-405f-a3f7-ddd8d6f5aea1",
    "spaces_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/spaces",
    "domains_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/domains",
    "private_domains_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/private_domains",
    "users_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/users",
    "managers_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/managers",
    "billing_managers_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/billing_managers",
    "auditors_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/auditors",
    "app_events_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/app_events",
    "space_quota_definitions_url": "/v2/organizations/8b6f23e3-64ef-48aa-925a-f5c38c7ccfdf/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1330
X-Content-Type-Options: nosniff