Desk

Run Desk Card Play

Run one play against this card's entity. REACHES THE OUTSIDE WORLD.

A play is a workflow, and a workflow can email, send a LinkedIn message or push to a third party. That is why this is not a plain write: the grant to fire one is the grant to have graph8 act on a customer's behalf.

IDEMPOTENT per (org, card, play) for one hour, so a retried press does not fire twice. The play is re-validated against this card's own eligible list, so an action_id the listing hides cannot be run by posting it directly, and the workflow's steps are re-read fresh on every press rather than from the listing's cache.

409 is a refusal, not a failure: the workflow exists and the caller may see it, the desk just will not fire it - and nothing has spent at that point.

post/desk/decisions/{decision_id}/plays/{action_id}/run

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/decisions/{decision_id}/plays/{action_id}/run
  • Auth: HTTP bearer

Path parameters

decision_idstring required

Decision id (UUID).

action_idstring required

Play id, from /desk/decisions/{id}/plays.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataDeskPayload required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

Changes

No recorded changes to this operation across all 2 revisions of this API.