Send enrollment notification email

POST

https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates/{emmEnrollmentTemplateId}/notify

curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates/{emmEnrollmentTemplateId}/notify" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "emails": [
    "[email protected]"
  ],
  "language": "es",
  "emailText": "string"
}'

const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates/{emmEnrollmentTemplateId}/notify", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "emails": [
      "[email protected]"
    ],
    "language": "es",
    "emailText": "string"
  }),
});

const data = await response.json();

import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/android/enterprise/enrollment-templates/{emmEnrollmentTemplateId}/notify",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "emails": [
        "[email protected]"
      ],
      "language": "es",
      "emailText": "string"
    },
)

data = response.json()

Request

Send your API key in the request header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

emmEnrollmentTemplateId string

required

Unique identifier for Android enrollment template configuration within organizational EMM deployment.

Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json

emails array [string] required

Array of recipient email addresses for sending enrollment instructions and device setup credentials.

language string optional

Language code for enrollment notification email localization and user communication preferences.

es en fr de it zh pt ru

emailText any optional

Custom message text appended to enrollment notification email providing context or instructions.

{
    "emails": [
        "[email protected]"
    ],
    "language": "es",
    "emailText": "string"
}

Responses

200 Response application/json

status boolean required

data object required

id string required

Unique identifier for Android enrollment template configuration within organizational EMM deployment.

Match pattern: ^[a-fA-F0-9]{24}$

name string required

Human-readable enrollment template name identifying configuration purpose for Android device onboarding workflows.

≤ 128 characters

description any optional

Detailed enrollment template description explaining purpose, target devices, and configuration policies for administrators.

emmEnrollmentTokenId string optional

Android Enterprise enrollment token identifier linking template to Google Play managed configuration.

Match pattern: ^[a-fA-F0-9]{24}$

emmEnrollmentToken object optional

id string required

Unique enrollment token identifier used to track Android Enterprise device enrollment credentials throughout lifecycle.

Match pattern: ^[a-fA-F0-9]{24}$

organization string optional

Organization identifier owning this enrollment token and managing enrolled Android Enterprise devices under EMM policy.

Match pattern: ^[a-fA-F0-9]{24}$

emmEnterprise string optional

Android Enterprise (EMM) enterprise account identifier linked to Google Managed Play for device and app management.

Match pattern: ^[a-fA-F0-9]{24}$

emmPolicyAssignments array [object] optional

Ordered list of Android Enterprise policy assignments applied to devices enrolling with this token prioritized by sequence.

mdmUser object optional

MDM user account information associated with enrollment token including identifier and email for device ownership tracking.

emmDevice string optional

Android Enterprise device identifier created after successful enrollment using this token for device lifecycle tracking.

Match pattern: ^[a-fA-F0-9]{24}$

displayName any optional

Human-readable enrollment token name displayed in dashboard for administrative identification and organizational purposes throughout device lifecycle.

tags array optional

Custom classification labels for enrollment token organization enabling filtering, grouping, and policy automation across device fleet.

status string optional

Current enrollment token lifecycle state indicating availability for device enrollment or completion status tracking.

PENDING DONE DELETED EXPIRED

sendEmail any optional

Flag controlling whether enrollment instructions and QR code are automatically sent to MDM user email address.

managementMode string optional

Android Enterprise management mode defining device ownership and control level applied during enrollment process execution.

DEVICE_OWNER PROFILE_OWNER COPE USERLESS

emailText any optional

Custom message content appended to enrollment notification email for user-specific instructions or organizational policy communication.

config object optional

Technical enrollment configuration containing Google Cloud generated credentials and expiration settings for device provisioning.

_config any optional

Internal configuration data restricted to administrator access level containing sensitive enrollment credentials and system metadata.

summary object optional

Enrollment token overview containing human-readable management mode description and expiration information for dashboard display.

type string optional

Enrollment token type classifier indicating platform-specific enrollment method used for cross-platform MDM management dashboards.

≤ 128 characters

subType string optional

Enrollment token sub-classification providing additional context for specialized enrollment scenarios within Android Enterprise management.

≤ 128 characters

state string optional

Legacy enrollment token state field maintained for backward compatibility with previous API versions tracking lifecycle.

PENDING DONE DELETED EXPIRED

perpetual any optional

Flag indicating whether enrollment token has unlimited validity or follows standard expiration policy for continuous enrollment.

qrcodeUrl string optional

URL to downloadable QR code image embeddin enrollment credentials for Android device camera-based provisioning workflow.

enrollmentLink string optional

Deep link URL for Android enrollment initiation allowing web-based device provisioning without QR code scanning.

≤ 256 characters

createdAt string optional

ISO timestamp when enrollment token was created in system for audit tracking and lifecycle management purposes.

updatedAt string optional

ISO timestamp of last enrollment token modification for change tracking and synchronization across distributed systems.

segmentId integer optional

Segment identifier for scoping enrollment token into an specific segment

≥ 0 · ≤ 9007199254740991

emmPolicyId string optional

Android Enterprise policy identifier defining device restrictions and security settings for enrollment.

Match pattern: ^[a-fA-F0-9]{24}$

emmPolicy object optional

id string optional

Unique Android Enterprise policy identifier used to track configuration rules and security settings throughout lifecycle.

Match pattern: ^[a-fA-F0-9]{24}$

name string optional

Human-readable policy name displayed in dashboard for administrative identification and organizational purposes throughout device management.

≤ 128 characters

description string optional

Detailed policy description explaining configuration purpose business requirements and device restrictions for documentation purposes.

≤ 256 characters

version string optional

Policy version identifier synchronized with Google Android Enterprise policy version for change tracking purposes.

≤ 128 characters

config object optional

Google Android Enterprise policy configuration object containing device restrictions security settings and compliance rules.

_config object optional

Internal configuration data restricted to administrator access level containing sensitive policy credentials and system metadata.

packages object optional

Application package information mapping containing installed app details versions and configuration for reporting purposes.

emmEnterprise string optional

Android Enterprise (EMM) account identifier linked to Google Managed Play for device and application management.

Match pattern: ^[a-fA-F0-9]{24}$

private any optional

Flag indicating whether policy is private to organization or shared across enterprise for template purposes.

assets array [object] optional

List of asset assignments for deploying files certificates configuration data and resources to managed Android devices.

assetsInfo array [object] optional

Enriched asset metadata including file sizes deployment status and version information for monitoring and auditing purposes.

bookmarks array [object] optional

updatedAt string optional

ISO timestamp of last policy modification for change tracking synchronization and audit trail purposes.

createdAt string optional

ISO timestamp when policy was created in system for lifecycle tracking and compliance reporting purposes.

agentConfiguration object optional

MDM agent behavior settings controlling location tracking application monitoring and network status reporting on Android devices.

kioskLauncherConfiguration object optional

Kiosk launcher customization settings defining home screen layout lock screen behavior and application restrictions for dedicated devices.

certificateProviderIds array optional deprecated

Deprecated: Use certificateProviderAssignments instead. List of certificate provider identifiers for deploying PKI credentials and authentication certificates to Android devices.

certificateProviderAssignments array [object] optional

List of certificate provider assignments including credential storage preferences for deploying PKI credentials to Android devices.

applications array [object] required

List of application assignments defining managed apps with installation actions configuration and update policies for deployment.

applicationsInfo array [object] required

Enriched application metadata including app details names icons versions for dashboard display and reporting purposes.

segmentId integer optional

Segment identifier for scoping policy into an specific segment

≥ 0 · ≤ 9007199254740991

exposeToChildren any optional

rules array [object] optional

Array of enrollment rules defining conditional device configurations, policies, and automated actions during onboarding.

name any optional

displayNamePattern any optional

tags array optional

conditions array [object] optional

emmPolicyId string optional

Match pattern: ^[a-fA-F0-9]{24}$

emmPolicyAssignments array [object] optional

segmentId integer optional

≥ 0 · ≤ 9007199254740991

version string optional

Sequential version string tracking enrollment template configuration changes and synchronization state.

≤ 128 characters

updatedAt string optional

Timestamp indicating when enrollment template configuration was last modified or synchronized.

createdAt string optional

Timestamp indicating when enrollment template configuration was initially created in system.

devicesCount integer optional

Total number of Android devices currently enrolled and managed using this enrollment template.

≥ 0 · ≤ 9007199254740991

defaultZeroTouchConfiguration any optional

Flag designating template as default configuration for Android zero-touch enrollment automatic device provisioning.

defaultManagedDomain any optional

Flag designating template as default configuration for managed Google domain enrollment workflows.

auxiliaryFields array [object] optional

Array of custom input fields collected from users during enrollment for conditional policy application.

type string optional

select text

key string required

≤ 128 characters

title any optional

description any optional

options array [string] optional

signinDetail object optional

signinUrl string optional

Google Play enrollment URL for manual device enrollment accessing Android Enterprise configuration.

≤ 500 characters

signinEnrollmentToken string optional

Short enrollment token code for manual entry during Android Enterprise device setup process.

≤ 500 characters

qrCode string optional

Base64-encoded QR code image for scanning during Android device enrollment for automated configuration.

≤ 1000 characters

allowPersonalUsage string optional

Android work profile personal usage permission setting controlling user access to personal apps and data.

ALLOW_PERSONAL_USAGE_UNSPECIFIED PERSONAL_USAGE_ALLOWED PERSONAL_USAGE_DISALLOWED PERSONAL_USAGE_DISALLOWED_USERLESS

defaultStatus string optional

Sign-in detail default status indicator specifying if configuration is primary enrollment method.

SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED SIGNIN_DETAIL_IS_DEFAULT SIGNIN_DETAIL_IS_NOT_DEFAULT

enrollmentLink string optional

Direct enrollment link URL combining token and configuration for simplified device enrollment workflow.

≤ 500 characters

loginProviderTypes array [string] optional

Array of authentication provider types permitted for user verification during device enrollment workflow.

allowAutoContinue any optional

Flag enabling automatic progression through enrollment steps without requiring user interaction at each stage.

managementMode string optional

Android Enterprise management mode specifying device ownership and profile configuration for enrolled devices.

DEVICE_OWNER PROFILE_OWNER COPE USERLESS

segmentId integer optional

Segment identifier for scoping smart enrollment into an specific segment

≥ 0 · ≤ 9007199254740991

{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "emmEnrollmentTokenId": "string",
        "emmEnrollmentToken": {
            "id": "string",
            "organization": "string",
            "emmEnterprise": "string",
            "emmPolicyAssignments": [
                {
                    "emmPolicyId": "string",
                    "emmPolicy": "string",
                    "priority": 0
                }
            ],
            "mdmUser": {
                "id": "string",
                "email": "string"
            },
            "emmDevice": "string",
            "displayName": "string",
            "tags": [
                "string"
            ],
            "status": "PENDING",
            "sendEmail": true,
            "managementMode": "DEVICE_OWNER",
            "emailText": "string",
            "config": {
                "expirationTimestamp": "string",
                "code": "string"
            },
            "_config": "string",
            "summary": {
                "managementMode": "DEVICE_OWNER",
                "expirationTimestamp": "string"
            },
            "type": "string",
            "subType": "string",
            "state": "PENDING",
            "perpetual": true,
            "qrcodeUrl": "string",
            "enrollmentLink": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "segmentId": 0
        },
        "emmPolicyId": "string",
        "emmPolicy": {
            "id": "string",
            "name": "string",
            "description": "string",
            "version": "string",
            "config": {},
            "_config": {},
            "packages": {},
            "emmEnterprise": "string",
            "private": true,
            "assets": [
                {
                    "mdmAssetId": "string",
                    "location": "string",
                    "assetName": "string",
                    "scope": "user"
                }
            ],
            "assetsInfo": [
                {}
            ],
            "bookmarks": [
                {
                    "title": "string",
                    "description": "string",
                    "url": "https://example.com",
                    "iconBase64": "string",
                    "iconUrl": "string"
                }
            ],
            "updatedAt": "string",
            "createdAt": "string",
            "agentConfiguration": {
                "allowLocation": true,
                "allowPackageTime": true,
                "allowPackageTransfer": true,
                "allowNetworkStatus": true,
                "policyFeatures": {
                    "defaultViewFeature": "bookmarks",
                    "toggledFeatures": [
                        {
                            "name": "bookmarks",
                            "active": true
                        }
                    ],
                    "enableDefaultView": true
                }
            },
            "kioskLauncherConfiguration": {
                "displayDeviceName": true,
                "settingAction": "",
                "whitelistedApps": [
                    "string"
                ],
                "escapeHatchPassword": "string",
                "backgroundUrl": "string",
                "iconSize": "small",
                "screenAlwaysOn": true,
                "unlockPassword": "string",
                "inactivityLockTime": 0,
                "startingUpApps": [
                    {
                        "packageName": "string",
                        "config": {}
                    }
                ],
                "appsLayout": [
                    {
                        "type": "app",
                        "package": "string"
                    }
                ],
                "header": {
                    "text": "string",
                    "fontSize": "small"
                },
                "footer": {
                    "text": "string",
                    "fontSize": "small"
                }
            },
            "certificateProviderIds": [
                "string"
            ],
            "certificateProviderAssignments": [
                {
                    "certificateProviderId": "string",
                    "storeCredentials": true
                }
            ],
            "applications": [
                {
                    "emmApplicationId": "string",
                    "configuration": "string",
                    "action": "forceInstall",
                    "updatePolicy": {},
                    "customAppConfig": {}
                }
            ],
            "applicationsInfo": [
                {
                    "emmApplicationId": "string",
                    "emmApplication": {
                        "id": "string",
                        "organizationId": "string",
                        "emmEnterpriseId": "string",
                        "type": "build",
                        "config": {
                            "buildId": "string",
                            "applicationId": "string",
                            "mdmAssetId": "string",
                            "filter": "string"
                        },
                        "version": 0,
                        "updatedAt": "string",
                        "createdAt": "string",
                        "origin": "library",
                        "info": {
                            "id": "string",
                            "bundleId": "string",
                            "name": "string",
                            "icon": "string",
                            "processedVersionName": "string",
                            "versionCode": "string",
                            "size": "string",
                            "originalExtension": "string",
                            "applicationInfo": {
                                "id": "string",
                                "slug": "string",
                                "name": "string",
                                "picture": "string"
                            },
                            "disabled": true,
                            "signatures": [
                                {
                                    "sha1": "string",
                                    "sha256": "string",
                                    "signatureScheme": "V1"
                                }
                            ]
                        }
                    }
                }
            ],
            "segmentId": 0,
            "exposeToChildren": true
        },
        "rules": [
            {
                "name": "string",
                "displayNamePattern": "string",
                "tags": [
                    "string"
                ],
                "conditions": [
                    {
                        "tags": [
                            [
                                "string"
                            ]
                        ],
                        "auxiliaryFields": [
                            [
                                "string"
                            ]
                        ],
                        "patterns": [
                            "string"
                        ],
                        "identifiers": [
                            "string"
                        ]
                    }
                ],
                "emmPolicyId": "string",
                "emmPolicyAssignments": [
                    {
                        "emmPolicyId": "string",
                        "priority": 0
                    }
                ],
                "segmentId": 0
            }
        ],
        "version": "string",
        "updatedAt": "string",
        "createdAt": "string",
        "devicesCount": 0,
        "defaultZeroTouchConfiguration": true,
        "defaultManagedDomain": true,
        "auxiliaryFields": [
            {
                "type": "select",
                "key": "string",
                "title": "string",
                "description": "string",
                "options": [
                    "string"
                ]
            }
        ],
        "signinDetail": {
            "signinUrl": "string",
            "signinEnrollmentToken": "string",
            "qrCode": "string",
            "allowPersonalUsage": "ALLOW_PERSONAL_USAGE_UNSPECIFIED",
            "defaultStatus": "SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED",
            "enrollmentLink": "string"
        },
        "loginProviderTypes": [
            "ldap"
        ],
        "allowAutoContinue": true,
        "managementMode": "DEVICE_OWNER",
        "segmentId": 0
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5050

message string optional

Feature not allowed for you billing plan

{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}

Request

Authorization

Path Params2

Request Body

Responses