LYlytics
Widgets

Update widget

Changed on

Update the version named in the body (404 if it does not exist), or create the next draft version when the body names none. State only changes through publish and pause; a body state must match the stored one. A published version's config, type and targeting cannot change until it is paused.

put/widget/{id}

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/widget/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

The widget id

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

Request body

aidinteger
configobject

Raw Pathfora SDK config

createdstring date-time
custom_rule_functionstring
descriptionstring
excluded_segment_idsstring[]
idstring
labelstring
modifiedstring date-time
personalization_keystring
published_atstring date-time
slugstring
state'draft' | 'published' | 'paused' | 'deleted'
state_modified_atstring date-time
target_segment_idsstring[]
versioninteger
widget_type'message' | 'form' | 'sitegate'

Response

Updated Widget

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes