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

Route

PUT /v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc

Body

{
  "name": "New Organization Name",
  "quota_definition_guid": "9255c939-877b-4bb6-9ea1-dc011087a830"
}

cURL

curl "https://api.[your-domain.com]/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "9255c939-877b-4bb6-9ea1-dc011087a830"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM2IiwiZW1haWwiOiJlbWFpbC0zNkBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDI0MTM3MzYzfQ.l7GcZwUOqC9o5BwWbsUGTuzLD4djdbKQ4QhdU2Hzpeg" \
	-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: 8cbeb705-c21d-4999-aec5-9d132fe922c3
Content-Length: 1330
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "56638d73-f0b0-42f9-b8c6-ffaf97e55ecc",
    "url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc",
    "created_at": "2015-02-10T01:42:43Z",
    "updated_at": "2015-02-10T01:42:43Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "9255c939-877b-4bb6-9ea1-dc011087a830",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/9255c939-877b-4bb6-9ea1-dc011087a830",
    "spaces_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/spaces",
    "domains_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/domains",
    "private_domains_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/private_domains",
    "users_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/users",
    "managers_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/managers",
    "billing_managers_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/billing_managers",
    "auditors_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/auditors",
    "app_events_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/app_events",
    "space_quota_definitions_url": "/v2/organizations/56638d73-f0b0-42f9-b8c6-ffaf97e55ecc/space_quota_definitions"
  }
}