Goals

Change goal status

Draft goals can activate; active goals can pause or complete; paused goals can resume or complete; completed goals can archive. Completion is blocked while negotiations, transactions, or recurring agreements remain active.

post/goals/{id}/actions

Request

  • Base URL: https://api.darwin.so/api/v1
  • URL: https://api.darwin.so/api/v1/goals/{id}/actions
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

Request body

action'PAUSE' | 'RESUME' | 'COMPLETE' | 'ARCHIVE' required
pausedUntilstring date-time

Response

The transitioned goal.

Changes

No recorded changes to this operation across all 1 revision of this API.