RErecurly

Goal API

get/paths/{path_id}/goal

Request

  • Base URL
    https://conduit.redfast.com
  • URL
    https://conduit.redfast.com/paths/{path_id}/goal
  • Auth
    none required

Path parameters

path_idstring required

ID from Path object returned from Ping API

Query parameters

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

accept_typestring

(optional) Should be set to accept2 if the user clicks on the secondary button

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
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.