The following macros are not currently supported in the header:
  • style

Create Address

UNDER DEVELOPMENT

The following endpoint can be used to creates new address.

POST [/:object_type/:object_id]/addresses

Where object_type and object_id describe the object you wish to create the address for. We currently support the following object types:

  1. Company
  2. Contact

Parameters

Table of allowed parameters. Underlined parameters are mandatory.

against_typestringThe type of object the address is against. e.g, company or contact. This is not required if you use the /:object_type/:object_id/addresses endpoint.
against_idunsigned intThe id of the object the address is against. This is not required if you use the /:object_type/:object_id/addresses endpoint.
overwirtebool, 1 or 0If the address to be created exists already, whether overwrite it.
state_idunsigned intMust point to a valid state. If you do not know the state id, please use the state parameter.
statestringThe name of the state or province
country_idunsigned intMust point to a valid country. If you do not know the country id, please use the country parameter.
countrystringThe name of the country.
titlestring 
street1string 
street2string 
citystring 
zipcode/postcodestring 
latitudestring 
longitudestring 
postalstring, 'yes' or 'no'This indicates whether this address is a postal address
physicalstring, 'yes' or 'no'This indicates whether this address is a physical address

Handling the response

Please see the GET address for controlling the response.