Update an existing inApp campaign

put https://api.indigitall.com/v2/inapp/campaign/{id}

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

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

number

required

inApp's id

Query Params

includeMetadata

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

schemaId

integer

campaign Schema id

name

string

length ≤ 250

campaign name

content

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']

enabled

boolean

If campaign is enabled

properties

object

campaign properties

filters

object

campaign filters

customData

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

startDate

date-time | null

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

Ex:

2019-02-13T08:18:39.632Z

endDate

date-time | null

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

Ex:

2019-02-13T08:18:39.632Z

metadata

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.

cacheTtl

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

Response body

object

statusCode

integer

required

Response code

message

string

required

Response message, usually OK

data

object

required

integer

required

campaign id

createdAt

string

required

Creation date. ISO date format - 8601

updatedAt

string

required

Update date. ISO date format - 8601

applicationId

integer

required

Application id

schemaId

integer

required

campaign Schema id

name

string

required

campaign name

contentUrl

string

required

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']

enabled

boolean

required

If campaign is enabled

properties

object

required

campaign properties

Has additional fields

filters

object

required

campaign filters

startDate

date-time | null

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

Ex:

2019-02-13T08:18:39.632Z

endDate

date-time | null

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

Ex:

2019-02-13T08:18:39.632Z

metadata

string | null

Information necessary to represent the campaign in the edit interface.

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

cacheTtl

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.

customData

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

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PUT \
2
     --url 'https://api.indigitall.com/v2/inapp/campaign/id?includeMetadata=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Parameters missing or not in right format

401Invalid credentials

403Operation forbidden for your user

404InApp not found

500Server error