POST/v1/definitions/{key}/rows/{rowId}/contract

Draw up a deal's contract

Moves one deal's CONTRACT track by naming the action: create, review, send, sign, execute, expire, void or cancel. A contract is drawn against an ACCEPTED offer, and every later move must be legal from where the track stands — an illegal one is refused with a sentence naming the state it is in. Answers the track as it now reads. Deals page only.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

rowIdpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "history": [
      {
        "action": "string",
        "actorKind": "string",
        "actorUserId": "",
        "createdAt": "string",
        "detail": "string",
        "entityId": "",
        "entityKind": "string",
        "entityRowId": "",
        "entityUuid": "string",
        "id": "",
        "requestId": ""
      }
    ],
    "status": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

curl --request POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/definitions/string/rows/{rowId}/contract' \ --header 'Content-Type: application/json' \ --data '{ "body": { "action": "string", "amount": 1.5, "documentUrl": "string", "offerRowId": "", "reason": "string", "recipientEmail": "string", "recipientName": "string", "signerEmail": "string", "signerName": "string", "signers": [ "string" ] }, "params": { ":key": "string", ":rowId": "" }, "query": {}}'

{ "data": { "history": [ { "action": "string", "actorKind": "string", "actorUserId": "", "createdAt": "string", "detail": "string", "entityId": "", "entityKind": "string", "entityRowId": "", "entityUuid": "string", "id": "", "requestId": "" } ], "status": "string" }}