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

Update default custom message assignment

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

default-custom-message

Path Params
string
required
length ≤ 9999

The ID of the custom message to be assigned as the default for the specified
type and purpose.

The type of this assigned default must match the type of the referenced
message.

The purpose of this assigned default must match the purpose of the referenced
message.

Query Params
string

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

string

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

string

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

Body Params

default-custom-messagebody object

string
required
length ≤ 9999

The ID of the custom message to be assigned as the default for the specified
type and purpose.

The type of this assigned default must match the type of the referenced
message.

The purpose of this assigned default must match the purpose of the referenced
message.

string
enum
required

The purpose of a default message to assign.

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 a default message to assign.

Show Details
EMAILThe type for a custom email message
SMSThe type for a custom SMS message
Allowed:
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