Update Related Account Type
This endpoint allows you to update a specific Related Account Type. If the specified Type does not exist, the response will be a "bad request".
You will only be able to update a Related Account Type 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 Type. In order to update a Type, 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 |
|---|---|---|
| descriptionBR | String | Direct relationship name of the Related Account Type in Brasilian Portuguese |
| descriptionDE | String | Direct relationship name of the Related Account Type in German |
| descriptionDK | String | Direct relationship name of the Related Account Type in Dutch |
| descriptionEN | String | Direct relationship name of the Related Account Type in English |
| descriptionES | String | Direct relationship name of the Related Account Type in Spanish |
| descriptionFR | String | Direct relationship name of the Related Account Type in French |
| descriptionIT | String | Direct relationship name of the Related Account Type in Italian |
| descriptionPT | String | Direct relationship name of the Related Account Type in Portuguese |
| descriptionRU | String | Direct relationship name of the Related Account Type in Russian |
| descriptionUS | String | Direct relationship name of the Related Account Type in American English |
| reverseDescriptionBR | String | Inverse relationship name of the Related Account Type in Brasilian Portuguese |
| reverseDescriptionDE | String | Inverse relationship name of the Related Account Type in German |
| reverseDescriptionDK | String | Inverse relationship name of the Related Account Type in Dutch |
| reverseDescriptionEN | String | Inverse relationship name of the Related Account Type in English |
| reverseDescriptionES | String | Inverse relationship name of the Related Account Type in Spanish |
| reverseDescriptionFR | String | Inverse relationship name of the Related Account Type in French |
| reverseDescriptionIT | String | Inverse relationship name of the Related Account Type in Italian |
| reverseDescriptionPT | String | Inverse relationship name of the Related Account Type in Portuguese |
| reverseDescriptionRU | String | Inverse relationship name of the Related Account Type in Russian |
| reverseDescriptionUS | String | Inverse relationship name of the Related Account Type in American English |
RESPONSE
Returns a JSON with information about the Related Account Type just updated.
| Attribute | Description |
|---|---|
| Message | 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/accountsRelations/{ID}
- Auth: API key in header X-Session-Key
Headers
Request body
Response
Update Related Account Type
Changes
No recorded changes to this operation across all 1 revision of this API.