Skip to content

Create a skip reason

POST
/api/subscriptions/skip-reasons
curl --request POST \
--url https://api.usegro.co/api/subscriptions/skip-reasons \
--header 'Content-Type: application/json' \
--data '{ "label": "example", "description": "example", "is_active": true, "position": 1, "playbook_id": "example" }'

Creates a new skip reason for the current account. When at least one skip reason is active, customers must pick one when skipping.

Media typeapplication/json
object
label
required
string
>= 1 characters <= 255 characters
description
string
nullable <= 1000 characters
is_active
boolean
position
number
playbook_id
string
nullable

Example generated

{
"label": "example",
"description": "example",
"is_active": true,
"position": 1,
"playbook_id": "example"
}

Created skip reason

Media typeapplication/json
object
data
required
object
id
required
string
created_at
string
nullable
updated_at
string
nullable
is_active
required
boolean
account_id
required
string
label
required
string
description
string
nullable
position
required
number
playbook_id
string
nullable
playbook
object
id
string
name
string
status
string
Allowed values: draft active paused archived

Example

{
"data": {
"playbook": {
"status": "draft"
}
}
}