Skip to main content
POST
/
addresses
Import an address
curl --request POST \
  --url https://api.leanpay.fr/v1/public/addresses \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company": "<string>",
  "line1": "<string>",
  "city": "<string>",
  "postalCode": "<string>",
  "country": "<string>",
  "name": "<string>",
  "line2": "<string>",
  "line3": "<string>",
  "externalId": "<string>",
  "main": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "company": "<string>",
  "line1": "<string>",
  "line2": "<string>",
  "line3": "<string>",
  "city": "<string>",
  "postalCode": "<string>",
  "country": "<string>",
  "externalId": "<string>",
  "main": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Body

application/json

Address object to import

​
clientId
string<uuid>
required
​
company
string
required
Maximum string length: 80
​
line1
string
required
Maximum string length: 80
​
city
string
required
Maximum string length: 80
​
postalCode
string
required
Maximum string length: 80
​
country
string
required
Maximum string length: 80
​
name
string | null
Maximum string length: 80
​
line2
string | null
Maximum string length: 80
​
line3
string | null
Maximum string length: 80
​
externalId
string | null
Maximum string length: 80
​
main
boolean

Response

Returns the imported address

​
id
string<uuid>
​
tenantId
string<uuid>
​
clientId
string<uuid>
​
name
string | null
​
company
string
​
line1
string
​
line2
string | null
​
line3
string | null
​
city
string
​
postalCode
string
​
country
string
​
externalId
string | null
​
main
boolean
​
createdAt
string<date-time>
​
updatedAt
string<date-time>