Archive an expiry

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

editor or admin60/minAny method

Request

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

Response

{
  "message": "Expiry archived successfully"
}

Sets is_archive: true and state: onhold, and pauses the record's workflow attachments and collection triggers.

Body parameters

application/json

expiryIdstringrequired

Returns

200

Archived.

messagestringrequired

Errors

`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.