Skip to main content
POST
Propose an offer

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Body

application/json
rightId
string
required

Parent right to draw scope from (prefixed rgh_).

Example:

"rgh_3a91f8c20b6d4e75"

toOrgId
string
required

The counter-party org id.

scope
string
required

Sub-scope being offered; must be within the parent right's scope.

Minimum string length: 1
termsRef
string | null

Optional reference to off-chain commercial terms.

expiresAt
string<date-time>

Optional; must be in the future. Defaults to 7 days from now.

Response

The proposed offer.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"