Change an expiry's workflow state

posthttps://api.expiryedge.com/v1/updateExpiryState

editor or admin60/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/updateExpiryState' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expiryId": "exp_4Tq9sLm2",
  "state": "completed"
}'

Antwort

{
  "message": "Expiry state updated successfully",
  "state": "completed",
  "next_expiry": {
    "next_expiry_id": "exp_7Pn2xQa8",
    "next_expiry_date": "2027-10-15",
    "mode": "renew_as_copy",
    "occurrence_number": 2
  }
}

completed also sets is_done: true, fires on-done workflows and, for recurring records, creates or rolls forward the next occurrence (next_expiry).

Body-Parameter

application/json

expiryIdstringerforderlich
statestringerforderlich
Erlaubttodoinprogressonholdinreviewcompleted

Rückgabe

200

State updated.

messagestringerforderlich
statestringerforderlich
Erlaubttodoinprogressonholdinreviewcompleted
next_expiryobject | null

Fehler

`400`	The request is missing required fields or contains invalid values.
`401`	Missing, expired or invalid bearer token.
`403`	Authenticated, but your role or organization does not allow this action.
`404`	The record does not exist or is not in your organization.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.