Update a location of a deal

PATCH/deals/{deal_id}/locations/{id}

deals:write update_deal_locationIdempotent

Changes the fields you send and returns the link. A new location_id must be one of your organisation's locations from GET /locations, else 422 exists. A published deal accepts it. dry_run shows the result without saving it. Emits deal_location.updated and sends no email. Sending the previous values undoes it.

Path parameters

deal_idstring (uuid)Required#
The deal's id, a uuid. An unknown deal, or one the token can't see, returns 404.
idstring (uuid)Required#
The deal location's id.

Query parameters

dry_runboolean#
Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · DealLocationUpdate

location_idinteger#
One of your organisation's locations: an id from GET /locations. Another id returns 422 exists.
detailsstring | null#
Free text about this location, up to 1500 characters.

{
  "details": "Registered office"
}

Responses

200

The updated deal location.

DealLocation

{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "location_id": 1,
    "label": "string",
    "details": "string",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

404

Resource not found (error.code = not_found).

Error

422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/deals/{deal_id}/locations/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "details": "Registered office"
}'