Update an expiry's recurrence settings

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

editor or admin60/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/updateRecurrenceSettings' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expiryId": "exp_4Tq9sLm2",
  "is_recurring": true,
  "recurrence_type": "year",
  "recurrence_interval": 1,
  "recurrence_count": null,
  "recurrence_end_date": null,
  "recurrence_mode": "renew_as_copy"
}'

Antwort

{
  "message": "Recurrence settings updated successfully",
  "settings": {
    "is_recurring": true,
    "recurrence_type": "year",
    "recurrence_interval": 1,
    "recurrence_count": null,
    "recurrence_end_date": null,
    "recurrence_mode": "renew_as_copy",
    "updated_at": "2026-09-27T14:05:00.000Z"
  }
}

Replaces all recurrence fields. With is_recurring: false every recurrence field is cleared.

Body-Parameter

application/json

expiryIdstringerforderlich
is_recurringboolean
recurrence_typestring | null
Required when is_recurring is true.
Erlaubtdayweekmonthyear
recurrence_intervalinteger | null
Required when is_recurring is true.
min: 1
recurrence_countinteger | null
Stop after this many occurrences.
min: 1
recurrence_end_datestring | null
Must not be before the expiry date.
recurrence_modestring | null
Defaults to renew_as_copy.
Erlaubtrenew_as_copyrenew_same

Rückgabe

200

Updated; settings echoes what was stored.

messagestring
settingsobject

Fehler

`400`	Missing `expiryId` or invalid recurrence configuration (`details` lists the problems).
`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.