Home
Version 3
Organizations API

Organizations API

Update an Organization

PUT /v2/organizations/:guid

Request

Route

PUT /v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092

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": "42a9db06-69c4-4c03-9629-a9717a2e3286"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNSIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5Nzh9.vOVA8_Y-ste1PDN4fAJHj-u5xcFZfdw3NUDrZL6USjk
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "42a9db06-69c4-4c03-9629-a9717a2e3286"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNSIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5Nzh9.vOVA8_Y-ste1PDN4fAJHj-u5xcFZfdw3NUDrZL6USjk" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "2e65c701-a79f-4d01-8668-ccb6ae5e9092",
    "url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092",
    "created_at": "2016-01-13T17:29:38Z",
    "updated_at": "2016-01-13T17:29:38Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "42a9db06-69c4-4c03-9629-a9717a2e3286",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/42a9db06-69c4-4c03-9629-a9717a2e3286",
    "spaces_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/spaces",
    "domains_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/domains",
    "private_domains_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/private_domains",
    "users_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/users",
    "managers_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/managers",
    "billing_managers_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/billing_managers",
    "auditors_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/auditors",
    "app_events_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/app_events",
    "space_quota_definitions_url": "/v2/organizations/2e65c701-a79f-4d01-8668-ccb6ae5e9092/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 1330
X-Content-Type-Options: nosniff