Skip to main content
POST
Set or clear the marketer's custom display name.

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Path Parameters

id
integer
required

Numeric resource id.

Required range: x >= 1

Body

application/json
custom_name
string

Custom display name for this marketer. Letters / digits / spaces / underscore / hyphen / dot. Empty value clears any previously set name.

Required string length: 1 - 15
Pattern: ^[\p{L}\p{N} _\-\.]+$

Response

Saved.

success
boolean
data
object