Progress a candidate (supervised engagement request)
progress_candidateUse this when the user wants to ACT on a counterparty the exchange has already shown them: it raises a supervised ENGAGEMENT REQUEST for that candidate — the introduction — which is the step that turns a match into a conversation, and which nothing else in this app can take. The candidate must be the exact name of one counterparty from the list the exchange handed THIS participant, read back with get_exchange_answer; the exchange validates it against its live list and refuses anything else, so never invent a name and never name a firm found elsewhere. It raises a request: it does not select, award or commit. The call is staged: a dry run sends nothing, and the confirmed call is bound to the exact payload that dry run returned. Call once with dry_run=true to get the exact payload and a confirmation_token; call again with the same arguments plus that token to send. A token that does not match the payload is refused and nothing is sent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | The msgid / answer key of your accepted declaration. | |
| note | No | Optional note in the user's own words, passed to the desk. | |
| dry_run | No | true returns the payload and a confirmation_token, and raises nothing. | |
| candidate | Yes | The EXACT name of one candidate the exchange handed you. Never invented, never a name from elsewhere. | |
| request_id | Yes | Your own idempotency key for this request. | |
| confirmation_token | No | The token from the dry run, for the confirmed send. |