Configure channel connection

POST

/v1/actions/hospitality.action.configure_channel_connection/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.configure_channel_connection/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "ari_endpoint_url": "example", "channel_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "display_name": "example", "horizon_days": 1, "notes": "example", "partner_code": "example", "price_basis": "gross", "property_code": "example", "secret_ref": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.channel_connection" } }'

• Production API

Re-point a conduit: endpoint, publication horizon, price basis, credential reference, partner codes, or the set of demand channels it carries. Every parameter is optional and only the ones given move — this is a patch, not a restatement. rate_model is deliberately absent: switching between per-day and occupancy-based pricing means re-certifying with the partner and re-publishing the whole horizon, so it is a new conduit, not an edit. Emits channel_connection.configured.

Effects: modify hospitality.channel_connection; link hospitality.link.channel_connection_carries_channel; unlink hospitality.link.channel_connection_carries_channel.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.configure_channel_connection:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

ari_endpoint_url

HTTPS endpoint we publish ARI into

string

channel_ids

Demand channels this conduit carries (replaces the current set)

Array<string>

display_name

Human-readable name shown in the Explorer

string

horizon_days

Days forward from today that ARI is published for (1..=750)

integer

notes

Free-form operator notes

string

partner_code

The partner's identifier for our system

string

price_basis

Whether published amounts are gross, net, or both

string

Allowed values: gross net gross_and_net

property_code

The partner's identifier for this property

string

secret_ref

Name of the credential in the external secret store (never the value)

string

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.channel_connection

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked unlinked end_dated

link_type

required

Allowed values: hospitality.link.channel_connection_carries_channel

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: modified

object_type

required

Allowed values: hospitality.channel_connection

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.channel_connection_carries_channel"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.channel_connection"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.