OrgsSDK Templates

updateSdkTemplate

PUT
/api/v1/orgs/{org_id}/sdktemplates/{sdktemplate_id}

Update an SDK template's visual customization settings, such as branding images, colors, header text, welcome message, default state, or site association.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
sdktemplate_id*string
Formatuuid

Request Body

application/json

Request Body

Visual customization template for the mobile SDK experience

bg_image?string

Background image URL displayed by the SDK template

btn_flr_bgcolor?string

Floor button background color used by the SDK template, as a hex color

default?boolean

Whether this template is the default among available SDK templates

header_txt?string

Header text displayed by the SDK template

name*string

Display name used to identify the SDK template

search_txtcolor?string

Text color used for search controls in the SDK template, as a hex color

welcome_msg?string

Welcome message displayed by the SDK template

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sdktemplates/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "bg_image": "https://p.imgci.com/db/PICTURES/CMS/227700/227791.4.jpg",  "btn_flr_bgcolor": "#282828",  "default": true,  "header_txt": "Mist",  "name": "default",  "search_txtcolor": "#282828",  "welcome_msg": "Welcome to Mist"}