Skip to main content
POST
/
api
/
v1
/
theme
/
custom
POST /api/v1/theme/custom
curl --request POST \
  --url https://api.scoot.app/api/v1/theme/custom \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "theme": {
    "socialThemeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "socialThemeName": "<string>",
    "description": "<string>",
    "colorPrimary": "<string>",
    "colorSecondary": "<string>",
    "colorBackground": "<string>",
    "colorGradientBackground": "<string>",
    "colorButtonText": "<string>",
    "colorButtonBG": "<string>",
    "imageFarURI": "<string>",
    "imageMidURI": "<string>",
    "imageNearURI": "<string>",
    "previewImageURI": "<string>",
    "minimapImageURI": "<string>",
    "imageWidth": 123,
    "imageHeight": 123,
    "templateId": "<string>",
    "defaultArtifactSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "multiSize": true,
    "addToMiniMap": true,
    "tiles": [
      {
        "uri": "<string>",
        "x": 123,
        "y": 123,
        "width": 123,
        "height": 123
      }
    ],
    "uploadStatus": {
      "requestStatusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requestId": "<string>",
      "progress": 123,
      "failureReason": "<string>",
      "startedDateTime": "2023-11-07T05:31:56Z",
      "endedDateTime": "2023-11-07T05:31:56Z"
    }
  },
  "imageBytes": "aSDinaTvuI8gbWludGxpZnk=",
  "imageFarBytes": "aSDinaTvuI8gbWludGxpZnk=",
  "imageMidBytes": "aSDinaTvuI8gbWludGxpZnk=",
  "imageNearBytes": "aSDinaTvuI8gbWludGxpZnk=",
  "imageFarId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "imageMidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "imageNearId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "socialThemeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "socialThemeName": "<string>",
  "description": "<string>",
  "colorPrimary": "<string>",
  "colorSecondary": "<string>",
  "colorBackground": "<string>",
  "colorGradientBackground": "<string>",
  "colorButtonText": "<string>",
  "colorButtonBG": "<string>",
  "imageFarURI": "<string>",
  "imageMidURI": "<string>",
  "imageNearURI": "<string>",
  "previewImageURI": "<string>",
  "minimapImageURI": "<string>",
  "imageWidth": 123,
  "imageHeight": 123,
  "templateId": "<string>",
  "defaultArtifactSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dateCreated": "2023-11-07T05:31:56Z",
  "multiSize": true,
  "addToMiniMap": true,
  "tiles": [
    {
      "uri": "<string>",
      "x": 123,
      "y": 123,
      "width": 123,
      "height": 123
    }
  ],
  "uploadStatus": {
    "requestStatusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "requestId": "<string>",
    "progress": 123,
    "failureReason": "<string>",
    "startedDateTime": "2023-11-07T05:31:56Z",
    "endedDateTime": "2023-11-07T05:31:56Z"
  }
}
Creates or updates a custom theme.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
theme
object
​
imageBytes
string<byte>
​
imageFarBytes
string<byte>
​
imageMidBytes
string<byte>
​
imageNearBytes
string<byte>
​
imageFarId
string<uuid>
​
imageMidId
string<uuid>
​
imageNearId
string<uuid>

Response

200 - application/json

OK

​
socialThemeId
string<uuid>
​
type
enum<string>
Available options:
LAYERED,
SINGLE_IMAGE,
SINGLE_COLOR
​
socialThemeName
string
​
description
string
​
colorPrimary
string
​
colorSecondary
string
​
colorBackground
string
​
colorGradientBackground
string
​
colorButtonText
string
​
colorButtonBG
string
​
imageFarURI
string
​
imageMidURI
string
​
imageNearURI
string
​
previewImageURI
string
​
minimapImageURI
string
​
imageWidth
integer
​
imageHeight
integer
​
templateId
string
​
defaultArtifactSetId
string<uuid>
​
dateCreated
string<date-time>
​
multiSize
boolean
​
addToMiniMap
boolean
​
tiles
object[]
​
uploadStatus
object