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.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.4ci77A3CRSagFuAujZs9E9Xfewh11uJLf4HGNyMxNko
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PUT /v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559

Body

{
  "name": "New Organization Name",
  "quota_definition_guid": "6d3a01ce-e2d3-49b8-8377-299c14efc3e0"
}

cURL

curl "https://api.[your-domain.com]/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "6d3a01ce-e2d3-49b8-8377-299c14efc3e0"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExIiwiZW1haWwiOiJlbWFpbC0xMUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0NDcxNjg1fQ.4ci77A3CRSagFuAujZs9E9Xfewh11uJLf4HGNyMxNko" \
	-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: 0ade3d15-d7a1-43d2-921f-788e34d553fe
Content-Length: 1330
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "4c20e640-f427-4d09-a426-97641dfc3559",
    "url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559",
    "created_at": "2015-02-13T22:34:45Z",
    "updated_at": "2015-02-13T22:34:45Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "6d3a01ce-e2d3-49b8-8377-299c14efc3e0",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/6d3a01ce-e2d3-49b8-8377-299c14efc3e0",
    "spaces_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/spaces",
    "domains_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/domains",
    "private_domains_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/private_domains",
    "users_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/users",
    "managers_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/managers",
    "billing_managers_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/billing_managers",
    "auditors_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/auditors",
    "app_events_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/app_events",
    "space_quota_definitions_url": "/v2/organizations/4c20e640-f427-4d09-a426-97641dfc3559/space_quota_definitions"
  }
}