Reissue the redemption link of one claim this distributor recorded
One call of the distributor API, read from the interface description Yutai publishes. Every sample answer on this page is simulated: no real holder's data stands behind it. The formats every value travels in are the identifiers page's.
The call
/v1/claims/{id}/link
The key presents the claims.write scope.
The parameters
id- Required. The claim's own id, the one the claim answer carried: a clm_ prefixed ULID. It sits in the call's address.
What it answers
The fresh link: the claim's own id and the one absolute address its new token opens, built on the same public origin the granted answer names. Only the last link reissued opens the claim's page, so the previous link stops working the moment this answer leaves; the token itself is never stored, so this answer carries the only copy.
claimIdThe claim's own id, the one the claim answer carried.
Required. A string.
linkThe one absolute address where the holder finishes the claim.
Required. A string. It carries at least 1 and at most 512 characters.
The errors
Every refused call answers one object with one field, message: the plain sentence that says what did not happen. The sentence carries 1 to 512 characters, so a refusal never carries an id, a code or an exception's text.
| Status | What it answers |
|---|---|
| 401 | The key is missing, malformed, unknown, revoked or expired. |
| 403 | The key does not carry the scope. The call is also refused with 403, nothing read, when the distributor is paused, suspended or closed, when the key is paused, or when the key presents from an origin it does not allow. |
| 404 | No claim answers this id under this distributor's key: an unknown id, or one another distributor's key recorded. The answer is the same for both, so no claim id can be probed. |
| 409 | The claim the id names stands rejected or taken back, so it carries no redemption link to reissue. |
| 429 | The key made too many calls this minute. The Retry-After header names the seconds until the next window opens. Nothing was read. |
| 500 | The read failed inside Yutai. Nothing was changed. |