The following macros are not currently supported in the header:
- style
POST /companies
Resource URL
Create a new company object.
POST /companies ANY /companies?_method=post
Parameters
Table of allowed parameters.
name | string | The newly created companies name. For example, Bob's Burger Hut. |
---|---|---|
parent_id | unsigned int | An id of another company who will be the new company's parent. |
standing | string | The standing of the new company. This can be active, interested, inactive or prospect. |
status_id | unsigned int | An id of a company status. |
website | string | The new company's website |
phone | string | The new company's phone number. |
fax | string | The new company's fax. |
notes | string | Notes to be stored against the new company. |
profile.* | * | Custom profile value against company. |
_fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
Handling the response
Please see get company for details regarding handling of the response.
Sample Response
POST /companies.json?name=BobsHouse
{ "response" : {Â "name" : "BobsHouse", "id" : "4" }, "meta" : { "status" : "ok", "message" : "Everything executed as expected." } }