notification-rules

Validate Rule

Check a candidate document, and read it back, without storing it.

Open to any member, unlike /preview: it evaluates nothing and reads no event, so the answer is a property of the document the caller already holds -- plus the check every save makes, that an on-call list it names exists in this organization, and that a website-lead rule names only people that notification may reach.

post/notifications/rules/validate

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

Headers

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

Request body

decisionobject required
event_typesstring[]

Response

Successful Response

validboolean required

Changes

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