Account Addresses

Update Account Address

This endpoint allows you to update a specific Account Address. If the specified Address does not exist, the response will be a "bad request".

You will only be able to update an Account Address 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

This endpoint allows updating the information of a specific Account Address. In order to update an Address, 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.

AttributeTypeDescription
accountIdIntegerAccount to which the address is linked to
address1StringAccount's first address
address2StringAccount's second address
cityStringCity name
countryIdIntegerId of the Country that the address is referred to (see Countries resource)
descriptionStringA description added to the Account Address
postcodeStringPostcode of the address
regionStringRegion/State name

RESPONSE

Returns a JSON with information about the Account Address just updated.

AttributeDescription
MessageShows the operation status

RESPONSE CODES

StatusDescription
200 OKShows if operation succeeded
400 Bad RequestShows when an invalid request or the requested service is not available
put/accountAddresses/{ID}

Request

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

Headers

Acceptstring

Request body

address1string
citystring

Response

Update Account Address

Changes

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