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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNyIsImVtYWlsIjoiZW1haWwtMjU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTN9.3PKqHWALkVKvUfdYYKW1NCk_HEq7Ezw3CiRQy3RSFR8
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

Route

PUT /v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f

Body

{
  "name": "New Organization Name",
  "quota_definition_guid": "77c8a46d-1c2c-482c-838f-754a9d108391"
}

cURL

curl "https://api.[your-domain.com]/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "77c8a46d-1c2c-482c-838f-754a9d108391"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzNyIsImVtYWlsIjoiZW1haWwtMjU4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTN9.3PKqHWALkVKvUfdYYKW1NCk_HEq7Ezw3CiRQy3RSFR8" \
	-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: 7147f4fa-01b1-42c1-be48-f59c17052e39
Content-Length: 1340
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "f1e6c361-38e6-41a7-8bbc-919d3672941f",
    "url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f",
    "created_at": "2015-01-20T01:52:33+00:00",
    "updated_at": "2015-01-20T01:52:33+00:00"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "77c8a46d-1c2c-482c-838f-754a9d108391",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/77c8a46d-1c2c-482c-838f-754a9d108391",
    "spaces_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/spaces",
    "domains_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/domains",
    "private_domains_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/private_domains",
    "users_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/users",
    "managers_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/managers",
    "billing_managers_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/billing_managers",
    "auditors_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/auditors",
    "app_events_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/app_events",
    "space_quota_definitions_url": "/v2/organizations/f1e6c361-38e6-41a7-8bbc-919d3672941f/space_quota_definitions"
  }
}