Skip to main content
POST
social.connect.welcome.set

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
showByDefault
boolean
required

Show this tenant welcome screen on connect by default.

brandName
string

Brand heading.

Required string length: 1 - 60
logoUrl
string

HTTPS square logo.

theme
object

Screen copy and style.

Response

The result

showByDefault
boolean
required

Show this tenant welcome screen on connect by default.

brandName
string

Brand heading.

Required string length: 1 - 60
logoUrl
any

HTTPS square logo.

theme
object

Screen copy and style.