Create widget set button text

POST

/preorders/offers/{id}/widget/set_button_text

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/offers/example/widget/set_button_text \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "text": "Reserve Now" }'

• Production

Set the preorder button’s call-to-action label.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

text

required

Example

{
  "text": "Reserve Now"
}

Responses

200

Success — example response shown.

Media typeapplication/json

object

Example

{
  "button": {
    "text": "Reserve Now",
    "colors": {
      "enabled": true,
      "text_color": "#FFFFFF",
      "background_color": "#1a1a1a"
    }
  },
  "disclaimer": {
    "enabled": true,
    "text": "Expected to ship by August 2026"
  },
  "badge": {
    "enabled": true,
    "text": "Pre-Order"
  }
}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

404

The resource does not exist for this shop, or the action path is not registered.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Offer not found"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}