Skip to main content
POST
/
api
/
rest
/
addresses
Create One Address
curl --request POST \
  --url https://api.upwell.com/api/rest/addresses \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "canonicalAddress": {},
    "canonicalAddressId": "<string>",
    "city": "<string>",
    "company": {},
    "companyId": "<string>",
    "companyName": "<string>",
    "contactId": "<string>",
    "country": "AD",
    "customerId": "<string>",
    "locationCode": {},
    "locationCodeId": "<string>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "stateOrProvince": "<string>",
    "streetLine1": "<string>",
    "streetLine2": "<string>",
    "streetLine3": "<string>",
    "type": "ADDRESS_BOOK",
    "zipOrPostalCode": "<string>"
  }
}
'
{
  "createAddress": {
    "city": "<string>",
    "companyName": "<string>",
    "country": "AD",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "phoneNumber": "<string>",
    "stateOrProvince": "<string>",
    "streetLine1": "<string>",
    "streetLine2": "<string>",
    "streetLine3": "<string>",
    "type": "ADDRESS_BOOK",
    "updatedAt": "2023-11-07T05:31:56Z",
    "zipOrPostalCode": "<string>"
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
input
AddressesInsertInput · object

input type for inserting data into table "addresses"

Response

200 - application/json

Responses for POST /api/rest/addresses

​
createAddress
Addresses · object

columns and relationships of "addresses"