post

/user

This endpoint enables you to export data for a particular user.

e.g. You might have sent multiple emails to user xyz@gmail.com and now you want to retrieve the history of email sent. So this API endpoint will be helpful in such a scenerio.

Request Parameters

1 Header

Request Body

Schema
object
emailaddress
string

Email adddress of the recipient for which the data need to be fetched.

required
callbackURL
string

URL on which the response of this API i.e. the data of the recipient need to be posted.

required
TrackingID
string

This is a custom tracking ID, using which you can track the status of this request anytime and link back into your system. Some of the examples of Tracking ID are CRM/Support RequestID, Transaction ID, TicketID etc.

Responses

Schema
object
response
object
requestid
string

This is a system genertaed unique number through which you can track the status of the submitted request.

request_type
string

Type of request:

  1. export
  2. delete
  3. cancel
status
string

Status of your request:

  1. PENDING - Request is in pending status.
  2. SUCESS - Request sucessfully executed.
  3. FAILED - Request failed.
  4. REVOKED - The request is canceled.
trackingID
string

You can pass a Unique Identifier e.g. some Unique string/Integer by which you want us to identify this request. In future you can track the status of this request using this custom tracking ID too. It may contain alphanumeric, underscore, hyphen.

callbackURL
string

The URL on which the requested data will be posted.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.