Home
Version 3
Organizations API

Organizations API

Update an Organization

PUT /v2/organizations/:guid

Request

Route

PUT /v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024

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": "d8616cef-21a0-4707-a57d-d1772ab8fe5a"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NCIsImVtYWlsIjoiZW1haWwtMTUzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MTV9.vk936BY0wBP0ewgT7i_NFfoW_yhGuZQC_1Hv-kdIEOA
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "d8616cef-21a0-4707-a57d-d1772ab8fe5a"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NCIsImVtYWlsIjoiZW1haWwtMTUzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzIzMTM2MTV9.vk936BY0wBP0ewgT7i_NFfoW_yhGuZQC_1Hv-kdIEOA" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "629e5b20-e923-4a2d-b6b6-7aa700a1e024",
    "url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024",
    "created_at": "2015-05-15T16:53:35Z",
    "updated_at": "2015-05-15T16:53:35Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "d8616cef-21a0-4707-a57d-d1772ab8fe5a",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/d8616cef-21a0-4707-a57d-d1772ab8fe5a",
    "spaces_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/spaces",
    "domains_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/domains",
    "private_domains_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/private_domains",
    "users_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/users",
    "managers_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/managers",
    "billing_managers_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/billing_managers",
    "auditors_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/auditors",
    "app_events_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/app_events",
    "space_quota_definitions_url": "/v2/organizations/629e5b20-e923-4a2d-b6b6-7aa700a1e024/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bde50751-9a9a-4fe2-946f-19c6f336e409
Content-Length: 1330
X-Content-Type-Options: nosniff