RPost Web API Help Page

Get list of report filters

Get detailed report based of the specified filter options for RMail productline

Upload files for email attachments.If successful , a string id is returned.

Upload files for email attachments.If successful , a string id is returned.

Using OAuth2 to get a valid bearer token.

The path for generating tokens will be :”{url}/token”. {url} is the url of the Web API.Token expires in 14 days, so if the user tries to use the same token for authentication after 14 days from the issue time, his request will be rejected and HTTP status code 401 is returned.
Content type for this request is 'application/x-www-form-urlencoded'.
To get a valid token grant_type must be 'password' and username a valid email address.
Special characters in the password must be percent encoded. For example: ! should be %21 , # should be %23.

Register a new user. An email with an activation link will be sent to the user.Request body must be in jSon format.
ContentType for this request should be "application/json; charset=UTF-8".

Confirm user email. This endpoint is used for activating new user registrations.

Confirm user email. This endpoint is used for activating new user registrations.

Resends user registration activation email.This endpoint will send out the email only if user is registered and email has not been confirmed.

Update Firstname,LastName,PhoneNumber,TimeZone,Language of a registered user. Phone number will be updated only if the request contains a value for the phone number

Get logged in user's account details.

Get user account status details.Provides information if the user is registered or not and can use the RMail email service.
Note: Request url should add a trailing '/' at the end. For example: api/Account/Status/user@example.com/

Get user account status details.Provides information if the user is registered or not and can use the RMail email service.
Note: Request url should add a trailing '/' at the end. For example: api/Account/Status/user@example.com/

Change password.

Send notification for password reset.

Validate code for reset password.

Reset password.

LogOut.

Validate bearer token. Token should be considered valid only if response with status code 200 is returned.

Validate bearer token. Token should be considered valid only if response with status code 200 is returned.

Set language for customer

* Administrator only feature

Get status for esign messages
Note: If tracking id is invalid or is not an esign type, no data will be returned

Get signed contract documents by message tracking id.
Note: If tracking id is invalid, has passed its expiration date or is not an esign type, no data will be returned

Get largemail related filesize settings.The FileSize limit value is in MB.

To update the Expiration date in Attachment header tables.

Get list of country codes

Get list of country codes

Get list of country codes

Get list of industry codes

Get list of job function codes

Get list of time zones

Retrieve all supported languages.

Retrieve all plan types.

Retrieve all plan range values.

Retrieve all plan renewal type values.

Retrieve all plan unit types.

Retrieve all plan authorization types.

Retrieve all account types for provisioning. Types for adding providers - DT,SP,RS.

Send email.For a customer admin or administrator 'FromAddress' will be used from the request parameter.
For all other users as well as in the case when 'FromAddress' is not specified by an administrator user, 'FromAddress' will be logged in user's username(emailaddress).

Send email.For a customer admin or administrator 'FromAddress' will be used from the request parameter.
For all other users as well as in the case when 'FromAddress' is not specified by an administrator user, 'FromAddress' will be logged in user's username(emailaddress).

No documentation available.

** Uses Basic Authorization. Returns customer information

** Uses Basic Authorization

Get list of all customers

Get message status.This API endpoint will return details like TrackingId, sender, recipient, status of delivery for all the messages within a given date range or a message identified by the tracking id. The maximum allowed date range is only 24 hours.
TrackingId is optional but if tracking id is passed, date range will be ignored.

Get message status.This API endpoint will return details like TrackingId, sender, recipient, status of delivery for all the messages within a given date range or a message identified by the tracking id. The maximum allowed date range is only 24 hours.
TrackingId is optional but if tracking id is passed, date range will be ignored.

No documentation available.

Get receipt data.This API endpoint will return compressed zip format file with the all the receipt eml files included for a message, identified by the tracking id.
Tracking id for a message is found in the acknowledgement email received.

This end point will upload the .eml file to verify the uploaded receipt file.File will be submitted to verification process and once completed email will be sent to the message sender

To get information on the trial units left for an user.

To get information on the trial units left for an user.

To get information on the units left for the logged in user.

To get trial status information including units left and upgrade link for the logged in user.

Get user regitration status.Special characters in the email address if any, should be percentage encoded.
For example: If user email is adelé@somedomain.com.Request should be like: api/v1/Users/adel%c9@somedomain.com/RegistrationStatus

To get information on the units remaining for the logged in user for RMAIL productline.

Get user information by email address.
Note: Request url should add a trailing '/' at the end.For example: api/v1/Users/user@example.com/

Get user information by email address.
Note: Request url should add a trailing '/' at the end.For example: api/v1/Users/user@example.com/

Get user details for logged in user.

Get upgrade link by email address and app name

Get upgrade link by email address, app and brand name

Get upgrade and support link by email address and app name

Clear user encryption password

* RPost Administrator only feature