Create Announcement

POST /self/{shopId}/announcements

Path parameters

shopId integer(int32) Required

Body

title string Required

Minimum length is 5, maximum length is 150.
shortDescription string Required

Minimum length is 5, maximum length is 150.
description string Required

Minimum length is 5, maximum length is 8000.
unlisted boolean Required
private boolean Required
buttonText string | null
buttonLink string | null
Additional properties are NOT allowed

Responses

200

Announcement created

POST /self/{shopId}/announcements

curl \
 -X POST https://dev.sellpass.io/self/{shopId}/announcements \
 -H "Authorization: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"title":"string","shortDescription":"string","description":"string","unlisted":true,"private":true,"buttonText":"string","buttonLink":"string"}'

Request example

{
  "title": "string",
  "shortDescription": "string",
  "description": "string",
  "unlisted": true,
  "private": true,
  "buttonText": "string",
  "buttonLink": "string"
}

Request examples

{
  "title": "string",
  "shortDescription": "string",
  "description": "string",
  "unlisted": true,
  "private": true,
  "buttonText": "string",
  "buttonLink": "string"
}