Skip to main content
PUT
Update district
To change individual fields, use a partial update: PATCH changes only the fields you send. Update is a full replace: fields you do not send are cleared.
  • CityId is required; changing it moves the district to that city, which also changes the city of addresses using it.
  • Name is required and must be unique within the city.

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

districtId
string<uuid>
required

District ID.

Body

CityId
null | string<uuid>

Required. ID of a city from GET /api/v1/definitions/cities.

Name
null | string

Required. District name, unique within the city. At most 50 characters.

Example:

"KADIKÖY"

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.