Skip to main content
PATCH
Partially update address
Send only the fields you want to change; fields you do not send keep their current values. Rules and examples: partial update.
  • A field that is not sent stays unchanged, a field sent as null is cleared.
  • Validation runs on the whole merged record; setting a required field to null is rejected.
  • IsInvoiceAddress cannot be set to false; mark another address as the invoice address first.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

customerId
string<uuid>
required

Customer ID.

addressId
string<uuid>
required

Address ID.

Body

DistrictId
null | string<uuid>

Required. ID of a district from GET /api/v1/definitions/districts. City and country come from the district.

Address
null | string

Required. Street address.

Example:

"Caferağa Mah. Moda Cad. No: 10"

PostalCode
null | string

Postal code.

Example:

"34710"

IsInvoiceAddress
boolean

Whether this is the invoice address. A customer always has exactly one invoice address.

Example:

true

CoordinateX
null | number<double>

Location coordinate X.

Example:

40.9877

CoordinateY
null | number<double>

Location coordinate Y.

Example:

29.0254

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required
Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.