Update an Account
Lets you update the details of an existing company (account). It is mandatory to specify the “CompanyId” in the API URL.
API URL
URL
POST
https://{host}/v2/CompanyManagement.svc/Company.Update?accessKey=AccessKey&secretKey=SecretKey&companyId=CompanyId
URL Parameters
| Parameter | Description |
|---|---|
| CompanyId | Unique identifier of the company you want to update. |
Request
Content-Type: application/jsonJSON Body/Payload
{
"CompanyProperties": [
{"Attribute": "City","Value": "Bangalore"},
{"Attribute": "State","Value": "Karnataka"}
]
}
Request Parameters
| Parameter | Description |
|---|---|
| CompanyProperties | You can pass multiple attribute-value pairs based on the company details you want to update – E.g., “Attribute”: “City”,”Value”: “Bangalore” |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"AffectedRows": 1
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
