7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Docs

Guides & Documentation

Overview Quick Start Authentication Changelog

API Operations

All Operations

Account

User AccountDELETE User Account ProfileGET Update User Account ProfilePUT User LoginPOST User LogoutPOST Refresh Authentication TokenGET Login Via UAE PassGET Access TokenGET Update Mobile NumberPUT Verify Passwordless TokenPOST Get Application InfoPOST

Content

Content DetailsGET

Invoice

Download InvoiceGET

Notifications

Save Notification PreferencesPOST Notification PreferencesGET Notifications HistoryGET User Device TokenGET Register Device TokenPOST Send SMS OTPPOST Send Email OTPPOST Send IVR OTPPOST Verify OTPPOST

Payments

Add Payment CardPOST Payment CardDELETE Saved Payment CardsGET Download Payment InvoiceGET Payment HistoryGET Update Payment CardPOST

PoBoxes

Confirm Linking PO BoxPOST User PO BoxesGET Agency PO BoxesGET Agency Box Status FiltersGET PO Boxes By Mobile NumberGET Unlink PO BoxPOST Validate Linking PO BoxPOST

Shipments

Check Shipment OptionsGET Process Shipment ActionsPOST Calculate Shipment ChargesPOST Confirm Shipment Address Update PaymentPOST Get Shipment CountPOST Shipment DetailsGET Get Shipment ListPOST Shipment Tracking HistoryGET Update Shipment Delivery AddressPOST Update Shipment PO BoxPOST

Doc Hub

EP.Retail.PoBox.User.BackEnd.API EndPoints/Notifications//api/v1/Notifications/SendOTPEmail

Docs

Guides & Documentation

Overview Quick Start Authentication Changelog

API Operations

All Operations

Account

Content

Content DetailsGET

Invoice

Download InvoiceGET

Notifications

Payments

Add Payment CardPOST Payment CardDELETE Saved Payment CardsGET Download Payment InvoiceGET Payment HistoryGET Update Payment CardPOST

PoBoxes

Confirm Linking PO BoxPOST User PO BoxesGET Agency PO BoxesGET Agency Box Status FiltersGET PO Boxes By Mobile NumberGET Unlink PO BoxPOST Validate Linking PO BoxPOST

Shipments

Doc Hub

EP.Retail.PoBox.User.BackEnd.API EndPoints/Notifications//api/v1/Notifications/SendOTPEmail

Overview

Generates and sends a one-time password to the specified email destination. Intended for email-based verification and account security workflows.

Request builder

POST

/api/v1/Notifications/SendOTPEmail

Access Token

api-versionstring

*object

tostring

fromstring

applicationCodestring

numberOfOtpDigitsinteger

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Notifications/SendOTPEmail" \  -H "Content-Type: application/json" \  -d '{}'

{  "message": "string",  "payload": "string",  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Generates and sends a one-time password to the specified email destination. Intended for email-based verification and account security workflows.

Request builder

POST

/api/v1/Notifications/SendOTPEmail

Access Token

api-versionstring

*object

tostring

fromstring

applicationCodestring

numberOfOtpDigitsinteger

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

to?string

from?string

applicationCode?string

numberOfOtpDigits?integer

Formatint32

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Notifications/SendOTPEmail" \  -H "Content-Type: application/json" \  -d '{}'

{  "message": "string",  "payload": "string",  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

to?string

from?string

applicationCode?string

numberOfOtpDigits?integer

Formatint32

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`