Resource URL
Create a new company object.
| Code Block | ||
|---|---|---|
| ||
POST /companies ANY /companies?_method=post |
Parameters
Table of allowed paramatersparameters.
| 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
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.
...
Please see get company for details regarding handling of the response.
Sample Response
| Code Block | ||
|---|---|---|
| ||
POST /companies.json?name=BobsHouse |
...