Add org address

Org address APIs

Add org address

OVERVIEW

Overview

This API call is used to add a new address to an organisation object in the system.

HTTP Request

POST /api/5/orgaddresses?orgid=<ORGID>

HTTP Request Object

POST http://example.com/context/api/5/orgaddresses?orgid=101

XML Request Example

<address>
   <street1>55 King willian street</street1>
   <additional>2nd floor</additional>
   <state>blank</state>
   <postcode>EC4R 9AD</postcode>
   <countryname>Australia</countryname>
   <city>London</city>
   <status>active/pending/archive</status>
    <defaultaddress>1</defaultaddress>
   <externalid>ext_123</externalid>
   <phone>978654564</phone>
   <knownas>HighQ</knownas>
</address>

JSON Request Example

{
       "street1": "55 King willian street",
       "additional": "2nd floor",
       "state": "blank",
       "postcode": "EC4R 9AD",
       "countryname": "Australia",
       "city": "London",
       "status": "active/pending/archive",
        "defaultaddress": "1",
       "externalid": "ext_123",
       "phone": "978654564",
       "knownas": "HighQ"
}

HTTP Response

Success

HTTP response 200

Error

See API Error messages

XML Success Response (200-Ok)

<?xml version="1.0" encoding="UTF-8" ?>
<address>
<addressid>3</addressid>
<link>http://example.com/context/api/4/orgaddresses/3</link>
</address>

JSON Success Response (200-Ok)

{
   "address": {
       "addressid": "3",
       "link": "http://example.com/context/api/4/orgaddresses/3"
   }
}

Error messages

Summary	Ref Code (V4)	Ref Code (before V4)
The entered address' external ID already exists in the system	413	N/A

Comments

0 Comments

Last Updated: Jun 09,2023