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 Name of the company to be created 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" : [ ]
}

 

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.