API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create a custom message

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/custom-messages/

A custom message can be used with Central NAC portal profiles and visitor
management facilities to provide customized email and SMS messages for
Central NAC visitors.

Path Params
string
required
length ≤ 9999

Unique identifier for the custom message (must be a UUID).

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

custom-messagebody object

email
object

Custom email message configuration.

sms
object

Custom SMS message configuration.

string
length between 0 and 255

A description, or note, for the custom message.

string
required
length ≤ 9999

Unique identifier for the custom message (must be a UUID).

string
enum
required

The purpose of the custom message (e.g. PASSWORD_NOTICE, REGISTRATION, etc.).

The purpose defines where and how a custom message can be used, as well as
which replacement tokens must be included in the message.

The message types supported for each purpose are:

  • PASSWORD_NOTICE: EMAIL, SMS
  • REGISTRATION: EMAIL, SMS
  • SPONSOR_APPROVAL: EMAIL only
  • VERIFICATION_CODE: SMS only
  • VERIFICATION_LINK: EMAIL only

The replacement tokens that must, or may, be included in the message content
for each purpose are:

  • PASSWORD_NOTICE: may include: [account:username], [account:password]
  • REGISTRATION: may include: [account:username], [account:password]
  • SPONSOR_APPROVAL: must include: [account:sponsor-approval-url], may include: [account:username]
  • VERIFICATION_CODE: must include: [account:verification-code]
  • VERIFICATION_LINK: must include: [account:verification-url], may include: [account:username]
Show Details
PASSWORD_NOTICESpecifies that the custom message can be used to notify the user about account creation and password reset. A password notice may contain the [account:username] and [account:password] replacement tokens.
REGISTRATIONSpecifies that the custom message can be used to notify the user about registration of their account. A registration message may contain the [account:username] and [account:password] replacement tokens.
SPONSOR_APPROVALSpecifies that the custom message can be used to notify the sponsor of a registration request that requires their approval. A sponsor approval message must contain the [account:sponsor-approval-url] replacement token. A sponsor approval message may contain the [account:username] replacement token. This purpose is only applicable to EMAIL messages.
VERIFICATION_CODESpecifies that the custom message can be used to send a verification code to the user when registering an account. A verification code message must contain the [account:verification-code] replacement token. This purpose is only applicable to SMS messages, as email messages use the VERIFICATION_LINK purpose instead.
VERIFICATION_LINKSpecifies that the custom message can be used to send a verification link to the user when registering an account. A verification link message must contain the [account:verification-url] replacement token. A verification link message may contain the [account:username] replacement token. This purpose is only applicable to EMAIL messages, as SMS messages use the VERIFICATION_CODE purpose instead.
Allowed:
string
enum
required

The type of the custom message (e.g. EMAIL or SMS).

Show Details
EMAILThe type for a custom email message
SMSThe type for a custom SMS message
Allowed:
string
required
length between 1 and 255

Unique name for the custom message.

Responses

Updated 7 days ago

Language
Credentials
OAuth2
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 days ago