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

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

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

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

A description, or note, for the custom message.

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

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]

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

Unique name for the custom message.