Update an existing inApp campaign

Update a inApp campaign. The variables to be modified are passed through the body.

Log in to see full request history
timestatususer agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Path Params
number
required

inApp's id

Query Params
boolean
Defaults to false

includeMetadata = true always returns the metadata field in the response

includeMetadata = false the endpoint returns the metadata field only if that field has been edited

Body Params

new inApp's data

integer

campaign Schema id

string
length ā‰¤ 250

campaign name

string

campaign Content web (html).
This content is filtered, so not all html tags are valid.
Tags:

['h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'p', 'a', 'ul', 'ol', 'img', 'nl', 'li', 'b', 'i', 'strong', 'em', 'strike', 'code', 'hr', 'br', 'div', 'caption', 'pre', 'iframe', 'spam']

Attributes:

['href', 'align', 'alt', 'center', 'bgcolor', 'width', 'height', 'style', 'id', 'class', 'scr', 'name', 'target']
boolean

If campaign is enabled

properties
object

campaign properties

filters
object

campaign filters

array of strings | null

In this array, we define the name of the customizable variables to be used by the campaign

Ex:

["telephone", "age"]
customData
date-time | null

Start Date for campaign action. The format is ISO 8601, UTC-0

Ex:

2019-02-13T08:18:39.632Z
date-time | null

End Date for campaign action. The format is ISO 8601, UTC-0

Ex:

2019-02-13T08:18:39.632Z
string | null

Information necessary to representthe campaign in the edit interface.

This information is only stored, it is not used for any process in the backend.

integer | null
ā‰„ 600

In seconds. Time to live of the inapp cache on the user's device.

Once the cache lifetime has been exceeded, the device will consult the API to download the campaign again.

If null, a default value will be used.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json