API Reference

Get Web Inbox user messages

get
https://example.com/api/v1/messages/getusermessages
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Customer Id

string

IsVisitor boolean

double
        Customer local time offset in minutes. Optional, defaults to 0 if not specified. This is the UTC
        offset of the customers timezone (typically identified from browser timezone) e.g. if customer is
        at +1 hour timezone then pass +60.
        


        This field is used for evaluating message expiry etc. Consistently passing 0 results in measuring all
        times as UTC rather than customer local timezone.
int32

Maximum amount of messages to return. Optional, defaults to 50 if not specified.

int32

TenantId Id

uuid

Brand Id.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request

401

This response will be returned if the request is not authorized to access this resource.

404

This response will be returned if the request is invalid or missing required information.

500

This response will be returned if there is an error in the system that prevents the operation from being completed.

Updated 6 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 6 months ago