Related Accounts / Types

Create Related Account Type

This endpoint allows you to create a Related Account Type based on JSON input.

You will only be able to create a Related Account Type after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.

HEADERS

ParameterValueDescription
Content-Typeapplication/jsonLanguage in which all request and response bodies are encoded
Accept*/*Any data of whatever mime type is accepted
X-Session-KeyAUTH_TOKENThis field must be completed with the token obtained at the authentication

REQUEST

AttributeTypeDescription
descriptionBRStringDirect relationship name of the Related Account Type in Brasilian Portuguese
descriptionDEStringDirect relationship name of the Related Account Type in German
descriptionDKStringDirect relationship name of the Related Account Type in Dutch
descriptionEN (Required)StringDirect relationship name of the Related Account Type in English
descriptionESStringDirect relationship name of the Related Account Type in Spanish
descriptionFRStringDirect relationship name of the Related Account Type in French
descriptionITStringDirect relationship name of the Related Account Type in Italian
descriptionPTStringDirect relationship name of the Related Account Type in Portuguese
descriptionRUStringDirect relationship name of the Related Account Type in Russian
descriptionUSStringDirect relationship name of the Related Account Type in American English
reverseDescriptionBRStringInverse relationship name of the Related Account Type in Brasilian Portuguese
reverseDescriptionDEStringInverse relationship name of the Related Account Type in German
reverseDescriptionDKStringInverse relationship name of the Related Account Type in Dutch
reverseDescriptionENStringInverse relationship name of the Related Account Type in English
reverseDescriptionESStringInverse relationship name of the Related Account Type in Spanish
reverseDescriptionFRStringInverse relationship name of the Related Account Type in French
reverseDescriptionITStringInverse relationship name of the Related Account Type in Italian
reverseDescriptionPTStringInverse relationship name of the Related Account Type in Portuguese
reverseDescriptionRUStringInverse relationship name of the Related Account Type in Russian
reverseDescriptionUSStringInverse relationship name of the Related Account Type in American English

RESPONSE

Returns a JSON with information about the Related Account Type just created.

AttributeType
IdId assigned to the new Related Account Type
MessageThe operation status

RESPONSE CODES

StatusDescription
200 OKShows if operation succeeded
400 Bad RequestShows when an invalid request or the requested service is not available
post/accountsRelations

Request

  • Base URL: https://api.forcemanager.com/api/v4
  • URL: https://api.forcemanager.com/api/v4/accountsRelations
  • Auth: API key in header X-Session-Key

Headers

Acceptstring

Request body

descriptionENstring
reverseDescriptionENstring

Response

Create Related Account Type

Changes

No recorded changes to this operation across all 1 revision of this API.