Was this helpful?

 

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/companies

Description: Creates a company in an organization

Verb: POST
Auth: Basic Auth
Media types:
application/json
text/xml
Sample Request:
$ curl -H "Content-type:application/json" -X POST -d \
'{
  "name" : "theremin",
  "displayName" : "Theremin, Inc.",
  "organization" : "apifactory",
  "status" : "active",
  "attributes" : [ {
    "name" : "BillingCode",
    "value" : "4TBH674"
  } ]
}' \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies \
-u myname:mypass
Request Payload Elements:
Name Description Default Required?
name The name of the company to be created. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %. For example, Cat2 %_ is a legal name. N/A Yes
displayName Display name of the company to be created N/A Yes
status Status of the company: 'active" or 'inactive' Active Yes
attributes Name/value formatted attributes used to extend the default company profile N/A No
Sample Response:
{
  "apps" : [ ],
  "name" : "theremin",
  "displayName" : "Theremin, Inc.",
  "organization" : "apifactory",
  "status" : "active",
  "attributes" : [ {
    "name" : "BillingCode",
    "value" : "4TBH674"
  } ],
  "createdAt" : 1374677661153,
  "createdBy" : "andrew@apigee.com",
  "lastModifiedAt" : 1374677661153,
  "lastModifiedBy" : "andrew@apigee.com"
}
Response Payload Elements:
Name Description
name Name of the company
displayName Display name of the company
organization Organization in which the company is created
status Status of the company: 'active' or 'inactive'
attributes Custom name/value atributes used ot extend the default company profile
createdAt Unix time when the entity was created
createdBy Apigee username of the developer who created the company
lastModifiedAt Unix time when the entity was last modified
lastModifiedBy Apigee username of the developer who last modified the company
Errors:
{
  "code" : "developer.service.InvalidCompanyName",
  "message" : "Invalid Company Name",
  "contexts" : [ ]
}

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)