Update Company (by id)
PUT {{base_url}}/company/v2/companies/:companyId
The ‘Update company’ endpoint will let you update a specific company’s details when the company id is passed as a parameter.
Path variables
| Field | Type | Description |
|---|
| companyId | string | Unique identifier for the company |
Attributes
| Field Name | Type | Description |
|---|
| name | string | Company name |
| address | string | Registered address of the company |
| website | string | Website (www.smewebsite.com) |
| industry | string | Industry name |
| description | string | Company description |
| externalId | string | External ID that a partner may want to use to identify a company |
| crn | string | Companies house number; specific to companies registered with Companies house in the UK |
Success
204 No content
Error messages
| Condition | Response Status | Response Body |
|---|
| Without company id | 403 Forbidden | {“error”: “Invalid request”, “hint”: “Unsupported method or endpoint”} |
| Invalid company id | 404 Not Found | |
Request Body
{"externalId"=>"3456"}
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |