Skip to main content
POST
/
v2
/
seller-breaks
/
start
Start seller break
curl --request POST \
  --url https://api.gameboost.com/v2/seller-breaks/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "disable_all",
  "comment": "<string>"
}
'
{
  "data": {
    "id": 123,
    "comment": "<string>",
    "started_at": 123,
    "ended_at": 123,
    "created_at": 123,
    "updated_at": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
mode
enum<string>
required

Break mode

Available options:
disable_all,
disable_manual_allow_instant,
allow_all_with_reservation
Example:

"disable_all"

​
comment
string | null

Optional break comment. This maps to the internal seller break message.

Maximum string length: 5000

Response

A single seller break

​
data
object

Seller break session