Home
Version 3
Organizations API

Organizations API

Update an Organization

PUT /v2/organizations/:guid

Request

Route

PUT /v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920

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": "effdd1a6-9647-4409-8692-9a7b453a6cdb"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA1fQ.9FGjzRoGdefc3vZLPH8mUuQAwaoLT_6CN11jNPEiB8U
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "effdd1a6-9647-4409-8692-9a7b453a6cdb"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzIiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDYzNjE4NzA1fQ.9FGjzRoGdefc3vZLPH8mUuQAwaoLT_6CN11jNPEiB8U" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "9a470e03-29df-4c8a-bff1-835debce4920",
    "url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920",
    "created_at": "2016-05-12T00:45:05Z",
    "updated_at": "2016-05-12T00:45:05Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "effdd1a6-9647-4409-8692-9a7b453a6cdb",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/effdd1a6-9647-4409-8692-9a7b453a6cdb",
    "spaces_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/spaces",
    "domains_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/domains",
    "private_domains_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/private_domains",
    "users_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/users",
    "managers_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/managers",
    "billing_managers_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/billing_managers",
    "auditors_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/auditors",
    "app_events_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/app_events",
    "space_quota_definitions_url": "/v2/organizations/9a470e03-29df-4c8a-bff1-835debce4920/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 824b1360-1a0a-41ec-bec3-50e5748390bd
Content-Length: 1330
X-Content-Type-Options: nosniff