---
updatedAt: 2026-03-01T18:54:08.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/mfa/llms.txt
---

# Send enrollment email

Send enrollment email to a set of new users inviting them to Akamai MFA. This operation provides users with unique links to enroll and activate authentication devices in Akamai MFA.

# OpenAPI definition

```json
{
  "externalDocs": {
    "description": "See documentation for Akamai's Akamai MFA API",
    "url": "https://techdocs.akamai.com/mfa/reference"
  },
  "info": {
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "title": "Email enrollments",
    "version": "v1"
  },
  "openapi": "3.0.0",
  "paths": {
    "/email-enrollments": {
      "post": {
        "description": "Send enrollment email to a set of new users inviting them to Akamai MFA. This operation provides users with unique links to enroll and activate authentication devices in Akamai MFA.",
        "externalDocs": {
          "description": "See documentation for this operation in Akamai's Akamai MFA API",
          "url": "https://techdocs.akamai.com/mfa/reference/post-send-enrollment-email"
        },
        "operationId": "post-send-enrollment-email",
        "parameters": [
          {
            "description": "Unique identifier for the contract.",
            "in": "query",
            "name": "contractId",
            "required": true,
            "schema": {
              "example": "C-0N7RAC71",
              "type": "string"
            },
            "x-akamai": {
              "file-path": "parameters/contract-id-required.yaml"
            }
          },
          {
            "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).",
            "in": "query",
            "name": "accountSwitchKey",
            "required": false,
            "schema": {
              "example": "1-5C0YLB:1-8BYUX",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "example": {
                "userIds": [
                  "user_5JmO0b2SZMrc72a2C8A25R"
                ]
              },
              "schema": {
                "additionalProperties": false,
                "description": "Specifies a list of users to send enrollment emails.",
                "properties": {
                  "userIds": {
                    "description": "A set of users to send enrollment emails.",
                    "items": {
                      "minLength": 1,
                      "type": "string"
                    },
                    "minItems": 1,
                    "type": "array"
                  }
                },
                "required": [
                  "userIds"
                ],
                "type": "object",
                "x-akamai": {
                  "file-path": "schemas/assign-users.yaml"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": {
                  "userIds": [
                    "user_5JmO0b2SZMrc72a2C8A25R"
                  ]
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "Specifies a list of users to send enrollment emails.",
                  "properties": {
                    "userIds": {
                      "description": "A set of users to send enrollment emails.",
                      "items": {
                        "minLength": 1,
                        "type": "string"
                      },
                      "minItems": 1,
                      "type": "array"
                    }
                  },
                  "required": [
                    "userIds"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/assign-users.yaml"
                  }
                }
              }
            },
            "description": "The enrollment email was successfully sent to the users."
          },
          "400": {
            "content": {
              "application/problem+json": {
                "example": {
                  "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'",
                  "instance": "84093d15-1fd0-421c-9182-8c873165ef58",
                  "title": "Bad Request",
                  "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request"
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.",
                  "properties": {
                    "detail": {
                      "description": "Diagnostic instructions to locate and fix the problem.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "errors": {
                      "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.",
                        "properties": {
                          "detail": {
                            "description": "Diagnostic instructions to locate and fix the problem.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "instance": {
                            "description": "Unique value generated with each API call.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "status": {
                            "description": "The HTTP status code that categorizes this error case.",
                            "maximum": 600,
                            "minimum": 100,
                            "type": "integer"
                          },
                          "title": {
                            "description": "A summary of each error case.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "type": {
                            "description": "Identifies each error case.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "title",
                          "detail"
                        ],
                        "type": "object",
                        "x-akamai": {
                          "file-path": "schemas/problem-nested.yaml"
                        }
                      },
                      "minItems": 0,
                      "type": "array",
                      "uniqueItems": true
                    },
                    "instance": {
                      "description": "Unique value generated with each API call.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "title": {
                      "description": "A summary of each error case.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "description": "Identifies each error case.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "title",
                    "detail",
                    "instance"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/problem.yaml"
                  }
                }
              }
            },
            "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).",
            "x-akamai": {
              "file-path": "errors/400.yaml"
            }
          },
          "401": {
            "content": {
              "application/problem+json": {
                "example": {
                  "detail": "The request requires authentication.",
                  "instance": "84093d15-1fd0-421c-9182-8c873165ef58",
                  "title": "Unauthorized",
                  "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized"
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.",
                  "properties": {
                    "detail": {
                      "description": "Diagnostic instructions to locate and fix the problem.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "errors": {
                      "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.",
                        "properties": {
                          "detail": {
                            "description": "Diagnostic instructions to locate and fix the problem.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "instance": {
                            "description": "Unique value generated with each API call.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "status": {
                            "description": "The HTTP status code that categorizes this error case.",
                            "maximum": 600,
                            "minimum": 100,
                            "type": "integer"
                          },
                          "title": {
                            "description": "A summary of each error case.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "type": {
                            "description": "Identifies each error case.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "title",
                          "detail"
                        ],
                        "type": "object",
                        "x-akamai": {
                          "file-path": "schemas/problem-nested.yaml"
                        }
                      },
                      "minItems": 0,
                      "type": "array",
                      "uniqueItems": true
                    },
                    "instance": {
                      "description": "Unique value generated with each API call.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "title": {
                      "description": "A summary of each error case.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "description": "Identifies each error case.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "title",
                    "detail",
                    "instance"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/problem.yaml"
                  }
                }
              }
            },
            "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).",
            "x-akamai": {
              "file-path": "errors/401.yaml"
            }
          },
          "500": {
            "content": {
              "application/problem+json": {
                "example": {
                  "detail": "Error in fetching policy details.",
                  "instance": "84093d15-1fd0-421c-9182-8c873165ef58",
                  "title": "Internal Server Error",
                  "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error"
                },
                "schema": {
                  "additionalProperties": false,
                  "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.",
                  "properties": {
                    "detail": {
                      "description": "Diagnostic instructions to locate and fix the problem.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "errors": {
                      "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.",
                      "items": {
                        "additionalProperties": false,
                        "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.",
                        "properties": {
                          "detail": {
                            "description": "Diagnostic instructions to locate and fix the problem.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "instance": {
                            "description": "Unique value generated with each API call.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "status": {
                            "description": "The HTTP status code that categorizes this error case.",
                            "maximum": 600,
                            "minimum": 100,
                            "type": "integer"
                          },
                          "title": {
                            "description": "A summary of each error case.",
                            "minLength": 1,
                            "type": "string"
                          },
                          "type": {
                            "description": "Identifies each error case.",
                            "type": "string"
                          }
                        },
                        "required": [
                          "type",
                          "title",
                          "detail"
                        ],
                        "type": "object",
                        "x-akamai": {
                          "file-path": "schemas/problem-nested.yaml"
                        }
                      },
                      "minItems": 0,
                      "type": "array",
                      "uniqueItems": true
                    },
                    "instance": {
                      "description": "Unique value generated with each API call.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "title": {
                      "description": "A summary of each error case.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "type": {
                      "description": "Identifies each error case.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "type",
                    "title",
                    "detail",
                    "instance"
                  ],
                  "type": "object",
                  "x-akamai": {
                    "file-path": "schemas/problem.yaml"
                  }
                }
              }
            },
            "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).",
            "x-akamai": {
              "file-path": "errors/500.yaml"
            }
          }
        },
        "summary": "Send enrollment email",
        "tags": [
          "Email enrollments"
        ]
      },
      "x-akamai": {
        "file-path": "paths/email-enrollments.yaml",
        "path-info": "/email-enrollments"
      }
    }
  },
  "servers": [
    {
      "url": "https://{hostname}/amfa/v1"
    }
  ],
  "x-akamai": {
    "auth-type": "EDGE_GRID",
    "file-path": "01-email-enrollments.yaml"
  },
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python",
      "node"
    ]
  }
}
```