Home
Version 3
Organizations API

Organizations API

Update an Organization

PUT /v2/organizations/:guid

Request

Route

PUT /v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f

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": "2023d439-a379-4a4d-9fc6-02c1050a74f2"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MSIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDI2MDY0MX0.1QrCGybNPkvxONPOTJSPtO02rTlJkFF9-2KTrveAXZ8
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f" -d '{
  "name": "New Organization Name",
  "quota_definition_guid": "2023d439-a379-4a4d-9fc6-02c1050a74f2"
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MSIsImVtYWlsIjoiZW1haWwtOTNAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDI2MDY0MX0.1QrCGybNPkvxONPOTJSPtO02rTlJkFF9-2KTrveAXZ8" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "f8babd97-9f30-4da0-b721-fba9db5eaf4f",
    "url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f",
    "created_at": "2015-09-30T23:30:41Z",
    "updated_at": "2015-09-30T23:30:41Z"
  },
  "entity": {
    "name": "New Organization Name",
    "billing_enabled": false,
    "quota_definition_guid": "2023d439-a379-4a4d-9fc6-02c1050a74f2",
    "status": "active",
    "quota_definition_url": "/v2/quota_definitions/2023d439-a379-4a4d-9fc6-02c1050a74f2",
    "spaces_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/spaces",
    "domains_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/domains",
    "private_domains_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/private_domains",
    "users_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/users",
    "managers_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/managers",
    "billing_managers_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/billing_managers",
    "auditors_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/auditors",
    "app_events_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/app_events",
    "space_quota_definitions_url": "/v2/organizations/f8babd97-9f30-4da0-b721-fba9db5eaf4f/space_quota_definitions"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9f6fff2d-b3f6-49d6-8180-79d24fe54727
Content-Length: 1330
X-Content-Type-Options: nosniff