Deals

Add a location to a deal

POST/deals/{deal_id}/locations

Links a location to the deal and returns the link with a Location. location_id is required and must be one of your organisation's locations from GET /locations, else 422 exists; details is free text of up to 1500 characters. The same location can be added twice. A published deal accepts it. dry_run shows the result without saving it. Emits deal_location.created and sends no email. DELETE /deals/{deal_id}/locations/{id} 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.

Query parameters

  • dry_runboolean#

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

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DealLocationCreate

  • location_idintegerRequired#

    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.

{
  "location_id": 42,
  "details": "Head office"
}

Responses

201

The location was added.

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 POST https://your-org-domain/kong/core/api/v2/deals/{deal_id}/locations\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "location_id": 42,
  "details": "Head office"
}'