Dismiss API

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

This API should be invoked when the prompt is dismissed, declined or times out. Definitions for each are as follows:

  • Dismiss: User decides to remove the prompt from view (presses the X close icon). The dismissed prompt is subject to be shown to the user again per Redfast configuration.
  • Decline: User decides to decline the prompt from view (i.e. presses the button with the Cancel Button Text). The declined prompt will no longer be returned in the Ping API unless otherwise configured.
  • Timeout: The specified prompt timeout period has expired and the prompt is automatically removed from view. The timed out prompt is subject to be shown again per Redfast configuration.
Path Params
string
required

ID from Path object returned from Ping API

Query Params
string

Accepted values are dismiss, timeout, decline

string

Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.

string

Value from Path object returned from Ping API

Headers
string

Unique identifier for the unauthenticated user

string

Unique authenticated identifier for the user

Response

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