platform
2fa
2fa-configuration
manage-message-templates

Create 2FA Email message template

Once you have your 2FA application, create one or more Email message templates where your PIN will be dynamically included when you send the PIN message over Email.

post/2fa/2/applications/{appId}/email/messages

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

Path parameters

appIdstring required

ID of application for which requested message was created.

Request body

emailTemplateIdinteger required

Email template ID that should reference a previously created Broadcast template.

fromstring

The sender of the 2FA message, an email address with an optional sender name (e.g. company@example.com or Jane Smith <jane.smith@somecompany.com>).

landingPageIdstring

The ID of an opt out landing page to be used and displayed once an end user clicks the unsubscribe link. If not present, default opt out landing page will be displayed. Create a landing page in your Infobip account and use its ID, e.g., 1_23456.

pinLengthinteger

PIN code length.

pinType'NUMERIC' | 'ALPHA' | 'HEX' | 'ALPHANUMERIC'

Response

successful response

applicationIdstring

The ID of the application that represents your service (e.g. 2FA for login, 2FA for changing the password, etc.) for which the requested message has been created.

emailTemplateIdinteger

Email template ID that should reference a previously created Email template.

fromstring

The sender of the 2FA message, an email address with an optional sender name (e.g. company@example.com or Jane Smith <jane.smith@somecompany.com>).

landingPageIdstring

Opt out landing page ID that should reference a previously created landing page template.

messageIdstring

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

pinLengthinteger

PIN code length.

pinType'NUMERIC' | 'ALPHA' | 'HEX' | 'ALPHANUMERIC'

Changes

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