latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

events

Track the closing of an in-app message

Creates an inAppClose event for a specific user and in-app message. When not using Iterable's mobile SDKs, call this endpoint to indicate that the user tapped a close button, link or back button to close a particular in app-message.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

post/api/events/trackInAppClose

Request body

clickedUrlstring

url used to close the in-app

closeActionstring

The type of action that initiated the close (for example, <code>link</code>, <code>back</code>, or a custom value).

createdAtinteger

Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp.

emailstring

An email address that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

inboxSessionIdstring

Inbox SessionId

messageIdstring required

The ID of the message associated with the event

userIdstring

A user ID that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

Response

successful operation