Skip to main content
GET
List plan suggestion sets

Authorizations

Authorization
string
header
required

API key or access token

Query Parameters

planId
string
Pattern: ^[1-9][0-9]{0,14}$
campaignId
integer
Required range: 0 < x <= 9007199254740991
status
enum<string>
Available options:
AWAITING_MESSAGES,
AWAITING_APPROVAL,
APPROVED,
APPLYING,
APPLIED,
COMPENSATING,
COMPENSATED,
NEEDS_RECONCILIATION,
REJECTED,
SUPERSEDED,
EXPIRED,
APPLY_FAILED,
PARKED,
DRY_RUN_RECORDED
limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991

Response

List plan suggestion sets

planSuggestionSets
object[]
required
hasMore
boolean
required