Upload controller
APIs
POST api/Upload |
Upload files for email attachments.If successful , a string id is returned. |
POST api/v1/Upload |
Upload files for email attachments.If successful , a string id is returned. |
APIs
POST Token |
Using OAuth2 to get a valid bearer token. |
POST api/v1/Account/Register |
Register a new user. An email with an activation link will be sent to the user.Request body must be in jSon format. |
POST api/v1/Account/ConfirmEmail |
Confirm user email. This endpoint is used for activating new user registrations. |
POST api/v1/Account/ConfirmUserEmail |
Confirm user email. This endpoint is used for activating new user registrations. |
POST api/v1/Account/ResendActivationLink |
Resends user registration activation email.This endpoint will send out the email only if user is registered and email has not been confirmed. |
PUT api/v1/Account/Details |
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 api/v1/Account/Details |
Get logged in user's account details. |
POST api/v1/Account/ChangePassword |
Change password. |
POST api/v1/Account/ForgotPassword |
Send notification for password reset. |
POST api/v1/Account/Logout |
LogOut. |
POST api/v1/Account/ValidateToken |
Validate bearer token. Token should be considered valid only if response with status code 200 is returned. |
POST api/v1/Account/ValidateClientToken |
Validate bearer token. Token should be considered valid only if response with status code 200 is returned. |
APIs
GET api/v1/ESign/{trackingId}/status |
Get status for esign messages |
GET api/v1/ESign/{trackingId}/DownloadContract |
Get signed contract documents by message tracking id. |
APIs
GET api/v1/Lookup/TimeZone |
Get list of time zones |
GET api/v1/Lookup/Language |
Retrieve all supported languages. |
APIs
POST api/v1/Mail |
Send email.For a customer admin or administrator 'FromAddress' will be used from the request parameter. |
POST api/v1/EmailOverSMS |
No documentation available. |
APIs
POST api/v1/Receipt/MessageStatus |
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. |
GET api/v1/MessageInfo/{trackingId} |
No documentation available. |
GET api/v1/Receipt/{trackingId} |
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. |
APIs
GET api/v1/Users/TrialStatus/{username} |
To get information on the trial units left for an user. |
GET api/v1/Users/TrialStatus?username={username} |
To get information on the trial units left for an user. |
GET api/v1/Users/TrialStatusAndUpgradeLink/{clientId} |
To get trial status information including units left and upgrade link for the logged in user. |
GET api/v1/Users/{emailAddress}/RegistrationStatus |
Get user regitration status.Special characters in the email address if any, should be percentage encoded. |
GET api/v1/Users/UsageRemaining |
To get information on the units remaining for the logged in user for RMAIL productline. |
GET api/v1/Users/ProductlineUsageRemaining |
To get information on the units remaining for the logged in user for RMAIL/RSign/RDocs productlines. |
GET api/v1/Users?address={address} |
Get user information by email address. |
GET api/v1/Users/{address} |
Get user information by email address. |
GET api/v1/Users/Detail |
Get user details for logged in user. |
POST api/v1/Users/ClearEncryptionPassword |
Clear user encryption password * RPost Administrator only feature |