---
title: "Create custom email configuration"
method: POST
path: "/api/v2/customemails"
tags: ["Custom Emails"]
---

# Create custom email configuration

`POST /api/v2/customemails`

## Request

- Base URL: `https://console.jumpcloud.com`
- URL: `https://console.jumpcloud.com/api/v2/customemails`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/customemails/post.ts> (a function with typed inputs; its response is checked against the schema)

Create the custom email configuration for the specified custom email type.

This action is only available to paying customers.

## Headers

- `x-org-id` string

## Request body

- CustomEmail: Custom email content created by the admin user to personalize emails sent to their system users.
  - `id` string
  - `type` 'activate_gapps_user' | 'activate_o365_user' | 'lockout_notice_user' | 'password_expiration' | 'password_expiration_warning' | 'password_reset_confirmation' | 'user_change_password' | 'activate_user_custom', required
  - `subject` string, required
  - `title` string
  - `header` string
  - `body` string
  - `button` string
  - `nextStepContactInfo` string

## Response `201`

OK

- CustomEmail: Custom email content created by the admin user to personalize emails sent to their system users.
  - `id` string
  - `type` 'activate_gapps_user' | 'activate_o365_user' | 'lockout_notice_user' | 'password_expiration' | 'password_expiration_warning' | 'password_reset_confirmation' | 'user_change_password' | 'activate_user_custom', required
  - `subject` string, required
  - `title` string
  - `header` string
  - `body` string
  - `button` string
  - `nextStepContactInfo` string

## Other responses

- `400`: Bad Request
- `401`: Unauthenticated
- `403`: Unauthorized
- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)