# opportunities.link

## What it does

Link one specific contract document and acceptance occurrence, or omit activity/occurrence keys to link an accepted amendment. An active predecessor alone cannot win a renewal; each acceptance target belongs to one package.

## Before you send it

An authorized OAuth connection may call it, including a headless client. Effective membership, application grant and token permissions still apply. Describe `opportunities.link` through `GET /v1/catalog/commands/{name}` before acting.

This command does not accept `source_document_id` in its envelope. Any input evidence requirements remain as documented below.

## Inputs

Put these fields inside the envelope's `input` object. The outer envelope names the command, a stable `idempotency_key` and `effective_at`; [request and recovery rules](/docs/api/) explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `opportunityId` | string | Yes |  Minimum length: `1`. Example: `"opp_example"`. |
| `expectedRevision` | integer | Yes |  Minimum: `1`. Example: `1`. |
| `contractId` | string | Yes |  Minimum length: `1`. Example: `"ctr_successor"`. |
| `contractDocumentId` | string | Yes |  Minimum length: `1`. Example: `"doc_successor"`. |
| `activityKey` | string | No |  Minimum length: `1`. Example: `"accept"`. |
| `occurrenceKey` | string | No |  Minimum length: `1`. Example: `"signed"`. |

## After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns `commandId`, `replayed`, the command-specific `result` below and emitted `events` with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect `result` and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch `GET /v1/commands/{id}` with `commandId` to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with `events: []` and return a transient result and `commandId` without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain `no_change` is a separate success outcome with no persisted receipt.

### Result fields

Required means required within its containing object; an optional parent can be omitted.

| Field | Type | Required | Meaning and accepted values |
|---|---|---|---|
| `id` | string | Yes |  Minimum length: `1`. |
| `revision` | integer | Yes |   |


[All commands](/docs/command-reference/) · [Operation and errors](/docs/api-reference/operations/commands-execute/) · [Reusable schemas](/docs/api-reference/components/)

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

## Exact request schema


```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "opportunities.link"
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "opportunityId": {
          "type": "string",
          "minLength": 1
        },
        "expectedRevision": {
          "type": "integer",
          "minimum": 1
        },
        "contractId": {
          "type": "string",
          "minLength": 1
        },
        "contractDocumentId": {
          "type": "string",
          "minLength": 1
        },
        "activityKey": {
          "type": "string",
          "minLength": 1
        },
        "occurrenceKey": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "opportunityId",
        "expectedRevision",
        "contractId",
        "contractDocumentId"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}
```

## Accepted command receipt


```json
{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "revision": {
          "type": "integer"
        }
      },
      "required": [
        "id",
        "revision"
      ]
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

## Example request


```json
{
  "name": "opportunities.link",
  "input": {
    "opportunityId": "opp_example",
    "expectedRevision": 1,
    "contractId": "ctr_successor",
    "contractDocumentId": "doc_successor",
    "activityKey": "accept",
    "occurrenceKey": "signed"
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "opportunities.link-example-0"
}
```