Update a trigger rule

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

editor or admin60/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/updateCollectionTriggerRule?id=trg_2Vb8' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "triggerDays": 45,
  "status": "pending"
}'

Antwort

{
  "message": "Trigger updated"
}

Send any subset of the fields. Changing timing recomputes trigger_date and re-arms the rule (pending, or paused for manual) unless status is also sent. status accepts only pending, paused or cancelled (others are ignored). Rules in another organization return 404. The handler does not check the HTTP method.

Query-Parameter

idstring
Rule id (or id in the body).

Body-Parameter

application/json

idstring
Alternative to the id query parameter.
templateIdstring
triggerTypestring
Erlaubtbefore_expiryon_expiryafter_expiryon_dateon_doneon_renewalmanual
triggerDaysinteger
min: 0 · max: 3650
triggerTimestring
triggerDatestring
format: date-time
contactIdsarray of string
groupIdstring | null
null or empty clears the group.
expiresInDaysinteger | null
dueInDaysinteger | null
carryToRenewalboolean
statusstring
Erlaubtpendingpausedcancelled

Rückgabe

200

Success.

messagestringerforderlich

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.