Org address APIs
Update org address
OVERVIEW
Overview
This API call is used to change an address within an organisation object in the system.
HTTP Request
PUT /api/5/orgaddresses/<ADDRESSID>
URL Parameters
Parameter | Description |
ADDRESSID | The address ID to be updated |
Example : http://example.com/context/api/5/orgaddresses/12
HTTP Request Object
XML Request Example
<address> <street1>55 King willian street</street1> <additional>2nd floor</additional> <state>New jersey</state> <postcode>EC4R 9AD</postcode> <countryname>India</countryname> <city>London</city> <status>active/pending</status> <defaultaddress>1</defaultaddress> <externalid>ext_123</externalid> <phone></phone> <knownas>HighQ</knownas> </address>
JSON Request Example
{ "street1": "55 King willian street", "additional": "2nd floor", "state": "New jersey", "postcode": "EC4R 9AD", "countryname": "India", "city": "London", "status": "active/pending", "defaultaddress": "1", "externalid": "ext_123", "phone": "7896543213", "knownas": "HighQ" }
HTTP Response
Success
HTTP response 200
Error
See API Error messages
Error messages
Summary | Ref Code (V4) | Ref code (before V4) |
The given address ID is invalid | 308 | |
You do not have access to the given organisation ID | 318 | |
The address countryname is required. | 319 | |
The address countryname is invalid. | 309 | |
The defaultaddress attribute is invalid. It must be 1 or 0 | 313 | |
A city name is required | 301 | |
A city name can have a maximum of 50 characters | 302 | |
A postal code can have a maximum of 50 characters | 303 | |
The entered address' external ID already exists in the system | 413 |
Vijay Odedra - Understood, thank you for confirming.
Lisa Thompson please refer to this wiki. It lists APIs you can copy to over developer community. Please do not copy APIs other than these. APIs not mentioned in that wiki will be available from 4.5 onwards. Please contact me if you have any query.
Hi Vijay Odedra - have completed changes to the APIs as we need to copy these over to the Developer Community asap. Thank you.
CC: Imran Aziz
Last Updated: Nov 08,2024
Comments
3 Comments