POST /v1/entity/postal_address

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service


Path:  /v1/entity/postal_address

Authentication: API Key required, User ID required

Description: upload a postal address for an entity



Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
entity_id string yes The entity ID being manipulated
building_number string no Building name or number 36 or Colt House
address1 string yes Line 1 of address 14 Front Street
address2 string no Line 2 of address Canal View
address3 string no Line 3 of address The Burrow
town string no Town name Dublin
county string no county name County Dublin
province string no province name  
postcode string no postcode N6 5LU
address_type enum no "branch" or "head_office"
do_not_display Boolean no set to TRUE if address should not be displayed on websites.  Default is FALSE


Sample Success Response:

    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"

Docs Navigation