admin
notification-rules

Activate Rule

Put the newest version into service, and say what that stops covering.

422 when the stored document could never notify anyone, and also when it no longer validates. now_uncovered names what the version it replaced covered and this one does not.

Logged rather than stamped: putting a rule into service writes no version, so the chain cannot name who did it and the log line is the only record there is.

post/admin/notifications/rules/{rule_key}/activate

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

rule_keystring required

Query parameters

organization_idstring required

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

now_uncoveredstring[]
activated_by_user_idstring nullable
activated_atstring date-time nullable
deactivated_by_user_idstring nullable
deactivated_atstring date-time nullable
idstring required
rule_keystring required
namestring nullable required
event_typesstring[] required
versioninteger required
is_activeboolean required
created_by_user_idstring nullable required
created_atstring date-time required
updated_atstring date-time required
decisionobject required

Changes

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