platform
2fa
pin-sending-and-verification
send-pin-over-email

Send 2FA PIN code over Email

Send a PIN code over Email using previously created Email message template.

post/2fa/2/pin/email

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or API key in header Authorization
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Request body

applicationIdstring required

The ID of the application that represents your service, e.g. 2FA for login, 2FA for changing the password, etc.

fromstring

Use this parameter if you wish to override the sender from the created Email message template parameter from.

landingPagePlaceholdersobject

Key value pairs that will be replaced when using personalized opt out landing page. Placeholder keys should NOT contain curly brackets and should NOT contain a pin placeholder. Valid example: "landingPagePlaceholders":{"name":"John", "surname": "Smith"}

messageIdstring required

The ID of the Email message template (message with the PIN placeholder) that is sent to the recipient.

placeholdersobject

Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a pin placeholder. Valid example: "placeholders":{"firstName":"John"}

tostring required

Email address to which the 2FA message will be sent. Example: john.smith@example.com.

Response

successful response

pinIdstring

Sent PIN code ID.

tostring

Email address to which the 2FA message has been sent. Example: john.smith@example.com.

Changes

No recorded changes to this operation across all 1 revision of this API.