API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
API Resource Path: /companies/{company_name}
Updates an existing Company
Verb: POST
Auth: Basic AuthSample Request:
$ curl -H "Content-type:application/json" -X POST -d \
'{
"name" : "DevCompany",
"displayName" : "Developer Company",
"status" : "active",
"attributes" : [ {
"name" : "region",
"value" : "south"
} ]
}' \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies/{company_name} \
-u myname:mypass
Request Payload Elements:
| Name | Description | Default | Required? |
|---|---|---|---|
| name | Name of the company | N/A | Yes |
| displayName | Display name of the company | N/A | Yes |
| status | Status of the company: 'active" or 'inactive' | N/A | Yes |
| attributes | Name/value formatted attributes used to extend the default company profile | N/A | No |
{
"name" : "DevCompany",
"displayName" : "Developer Company",
"organization" : "myorg",
"status" : "active",
"attributes" : [ {
"name" : "region",
"value" : "north"
} ],
"createdAt" : 1343049811765,
"createdBy" : "Admin",
"lastModifiedAt" : 1343049811875,
"lastModifiedBy" : "Admin"
}
Response Payload Elements:
| Name | Description |
|---|---|
| name | Name of the company |
| displayName | Display name of the company |
| organization | Apigee organization of the company |
| status | Status of the company: Active or Inactive |
| attributes | Arbitrary attributes that can be used to customize the default company profile |
| createdAt | Unix time when the entity was created |
| createdBy | Apigee username of the user who created the company |
| lastModifiedAt | Unix time when the entity was last modified |
| lastModifiedBy | Apigee username of the user who last modified the company |
