Skip to main content
PATCH
/
api
/
v1
/
addresses
/
{addressId}
Partially update address
curl --request PATCH \
  --url https://api.contracting.kukkingu.software/api/v1/addresses/{addressId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant-id: <tenant-id>' \
  --data '
{
  "address1": "123 Main St",
  "address2": "Suite 400",
  "region": "California",
  "country": "United States",
  "city": "San Francisco",
  "zip": "94103",
  "order": 13
}
'
{
  "data": {
    "id": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
    "contact": "con_xlbg6ubfio7tzvsijyp5794c",
    "address1": "123 Main St",
    "address2": "Suite 400",
    "region": "California",
    "country": "United States",
    "city": "San Francisco",
    "zip": "94103",
    "createdAt": "2023-10-05T14:48:00.000Z",
    "updatedAt": "2023-10-05T14:48:00.000Z",
    "order": 13
  }
}

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"

Path Parameters

​
addressId
string
required

The ID of the address.

Example:

"adr_ekq4ymw1nyyd4b6k6f5tg3t6"

Body

application/json

Request body used to partially update an existing address resource.

Request body used to partially update an existing address resource.

​
address1
string

Primary address line.

Required string length: 1 - 200
Example:

"123 Main St"

​
address2
string

Secondary address line.

Maximum string length: 200
Example:

"Suite 400"

​
region
string

State or region for the address.

Maximum string length: 100
Example:

"California"

​
country
string

Country for the address.

Required string length: 1 - 100
Example:

"United States"

​
city
string

City for the address.

Required string length: 1 - 100
Example:

"San Francisco"

​
zip
string

Postal or ZIP code.

Required string length: 1 - 20
Example:

"94103"

​
order
integer

Order of the resource for sorting purposes.

Required range: 0 <= x <= 9007199254740991
Example:

13

Response

Default Response

Standard success response payload wrapped in a data property.

​
data
object
required

Address resource returned by the API.