Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Resource URL

/companies

Parameters

Table of allowed paramaters.

namestringThe newly created companies name. For example, Bob's Burger Hut.
parent_idunsigned intAn id of another company who will be the new company's parent.
standingstringThe standing of the new company. This can be active, interested, inactive or prospect.
status_idunsigned intAn id of a company status.
websitestringThe new company's website
phonestringThe new company's phone number.
faxstringThe new company's fax.
notesstringNotes to be stored against the new company.
profile.**Custom profile value against company.
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields paramater; see included examples. Underlined values are default.

idunsigned int 
namestring 
websitestring 
standingstring 
statusunsigned int or object 
phonestring 
faxstring 
date_createdunsigned int 
date_modifiedunsigned int 
commentsstring 
contactunsigned int or object 

Sample Response

POST /companies.json?name=BobsHouse
{
   "response" : { 
		 "name" : "BobsHouse",
         "id" : "4"
    },
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}
  • No labels