APIs
Sub-processorsAbout PismoContact us

Create address

post
https://sandbox.pismolabs.io/accounts/v1/accounts//addresses

Create a new address for the specified account.

This endpoint generates an Address created event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Account ID

Query Params
boolean
enum

Is address active?

Allowed:
Body Params

Address entity

An address request

string
enum
required

Address type

Allowed:
string
required
length ≤ 300

Street, avenue, road, and so on, name.

string
required
length ≤ 9

Address number as string or integer.

If you enter numeric characters, they are saved in the number address object field.

If you enter any non-numeric characters, all characters are saved in the extended_number address object field.

For example, if you enter "12 A", it gets saved as follows:

  • number = 12
  • extended_number = "12 A"
string
required
length ≤ 16

Zip/postal code

string
required
length ≤ 100

Address city

string
required
length ≤ 30

Address state

string
required
length ≤ 30

Address country

string
required
length ≤ 100

Address neighborhood. Some countries use neighborhood in addresses.

boolean

Is address active (true) or not (false). Default is true.

string
length ≤ 100

Any additional information such as suite, apt., and so on.

custom_fields
object

Key/value field for custom information. (Limited to 1014 bytes.)

boolean

Is this address the mailing address?

Only one address can have this field set to true.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago