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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMyIsImVtYWlsIjoiZW1haWwtMjQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxNDF9.0sE0Y2H7bSFLnRTC2gJ6dUUreMuqGRQA8S7p5GIcjCU
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

Route

PUT /v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4

Body

{
  "name": "New Organization Name",
  "quota_definition_guid": "a5eb8c62-6de0-4313-9fba-e11cc7c2fd93"
}

cURL

curl "https://api.[your-domain.com]/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "a5eb8c62-6de0-4313-9fba-e11cc7c2fd93"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwMyIsImVtYWlsIjoiZW1haWwtMjQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQzMTAxNDF9.0sE0Y2H7bSFLnRTC2gJ6dUUreMuqGRQA8S7p5GIcjCU" \
	-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: 08a93f11-f0d4-4117-b0a1-82a622783637
Content-Length: 1330
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "f3a94fdc-aa27-4706-b855-50c9ba1507a4",
    "url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4",
    "created_at": "2015-02-12T01:42:21Z",
    "updated_at": "2015-02-12T01:42:21Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "a5eb8c62-6de0-4313-9fba-e11cc7c2fd93",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/a5eb8c62-6de0-4313-9fba-e11cc7c2fd93",
    "spaces_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/spaces",
    "domains_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/domains",
    "private_domains_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/private_domains",
    "users_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/users",
    "managers_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/managers",
    "billing_managers_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/billing_managers",
    "auditors_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/auditors",
    "app_events_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/app_events",
    "space_quota_definitions_url": "/v2/organizations/f3a94fdc-aa27-4706-b855-50c9ba1507a4/space_quota_definitions"
  }
}