Skip to main content
PUT
Update dynamic image

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Dynamic image id. Get it from dynamicImages.list.

Pattern: ^\d+$

Body

application/json
name
string
required

Dynamic image name.

Required string length: 1 - 100
data
object
required

Image template document (layers, text, positioning).

customFieldId
string | null

Custom field id whose per-contact value personalizes the render.

Pattern: ^\d+$

Response

OK

id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
name
string
required
customFieldId
string | null
required
data
object
required
enabled
boolean
required
backgroundUrl
string | null
required

Public URL of the rendered static background.

imageUrl
string
required

Trigger URL to embed. Replace {{user_id}} with the contact's channel-side id to get a personalized render; without it the static background is served.