ERerply
Addresses

Create an address

Create an address

post/v1/addresses

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

address2string

Street address, line 2. This field is exposed via Erply user interface only for US, CA and MX accounts!

citystring

City, region, or county

countrystring
customerIdinteger
postCodestring

Postal code or ZIP code.

statestring

State. This field is exposed via Erply user interface only for US, CA and MX accounts!

streetstring

Street address. If address cannot be split into parts, put the whole address into this field.

typeIdinteger

Example request

{
  "city": "Spring",
  "country": "US",
  "postCode": "77386",
  "state": "TX",
  "street": "3757  Richland Avenue"
}

Response

Created

idinteger

Example response

{
  "id": 73
}

Changes

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