v1

latestOpenAPI 3.1.0MIT2026-07-2412028.8 KB

Dismiss API

get/paths/{path_id}/dismiss

Path parameters

path_idstring required

ID from Path object returned from Ping API

Query parameters

clickstring

Accepted values are dismiss, timeout, decline

device_typestring

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.

action_group_idstring

Value from Path object returned from Ping API

Headers

user-idstring

Unique identifier for the unauthenticated user

anonymous-user-idstring

Unique authenticated identifier for the user

Response

200

successboolean

Example response

{
  "success": true,
  "configs": {
    "ping_frequency": 10
  }
}