Update Related Account
The endpoint allows you to update a specific Related Account information from the user's ForceManager implementation database. If the specified Related Account does not exist, the response will be a "bad request".
You will only be able to update a Related Account after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
This endpoint allows updating the information of a specific Related Account. In order to update a Related Account, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| Attribute | Type | Description |
|---|---|---|
| accountOneId (Required) | Integer | First Account to be referred to the relationships |
| accountTwoId (Required) | Integer | Second Account to be referred to the relationships |
| relationId (Required) | Integer | Related Account Type that defines the type of the relationships (see Types resource) |
RESPONSE
Returns a JSON with information about the Related Account just updated.
| Attribute | Type | Description |
|---|---|---|
| Message | String | Shows the operation status |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountsRelated/{ID}
- Auth: API key in header X-Session-Key
Headers
Request body
Response
Update Related Account
Changes
No recorded changes to this operation across all 1 revision of this API.