Skip to main content
POST
/
api
/
v1
/
addresses
/
order
Reorder addresses
curl --request POST \
  --url https://api.contracting.kukkingu.software/api/v1/addresses/order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant-id: <tenant-id>' \
  --data '
{
  "contactId": "con_xlbg6ubfio7tzvsijyp5794c",
  "ids": [
    "adr_123",
    "adr_456"
  ]
}
'
{
  "data": [
    "adr_ekq4ymw1nyyd4b6k6f5tg3t6"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Body

application/json

Request body that defines the target order for addresses.

Request body that defines the target order for addresses.

contactId
string
required

The ID of the contact.

Example:

"con_xlbg6ubfio7tzvsijyp5794c"

ids
string[]
required

Ordered list of address IDs representing the desired sort order.

The ID of the address.

Example:
["adr_123", "adr_456"]

Response

Default Response

Standard success response payload wrapped in a data property.

data
string[]
required

Ordered list of address IDs after the reorder operation is applied.

The ID of the address.