Pause Message Rule

Pauses a message rule (it is kept but sends nothing) or turns it back on. Pausing stops the rule's scheduled messages that haven't been sent; turning it back on schedules them again. Requires the messageRules:write scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

_id of the message rule (from Get Message Rules)

Body Params
boolean
required

true to pause, false to turn the rule back on

Headers
string

Partner API key (deprecated — use OAuth 2.0 for new integrations)

string

User's authentication token (legacy). Use Authorization Bearer header for new integrations.

Responses

429

Too many requests

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json