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

Route

PUT /v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7

Body

{
  "name": "New Organization Name",
  "quota_definition_guid": "247076c2-c2d5-4263-b127-3aa1bbd65a94"
}

cURL

curl "https://api.[your-domain.com]/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "247076c2-c2d5-4263-b127-3aa1bbd65a94"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2NSIsImVtYWlsIjoiZW1haWwtMTI4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTY1MjY3MDR9.dst556fZW9VnOQOVhS_rSQPitFP7HVpfX7Z6Rh4oVt4" \
	-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: 49359532-9fc6-479a-b681-183859fd100a
Content-Length: 1340
X-Content-Type-Options: nosniff

Status

201 Created

Body

{
  "metadata": {
    "guid": "8f753a4b-1878-449d-9cb6-419c644f05f7",
    "url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7",
    "created_at": "2014-11-13T23:38:24+00:00",
    "updated_at": "2014-11-13T23:38:24+00:00"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "247076c2-c2d5-4263-b127-3aa1bbd65a94",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/247076c2-c2d5-4263-b127-3aa1bbd65a94",
    "spaces_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/spaces",
    "domains_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/domains",
    "private_domains_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/private_domains",
    "users_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/users",
    "managers_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/managers",
    "billing_managers_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/billing_managers",
    "auditors_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/auditors",
    "app_events_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/app_events",
    "space_quota_definitions_url": "/v2/organizations/8f753a4b-1878-449d-9cb6-419c644f05f7/space_quota_definitions"
  }
}