---
title: "Create an engagement setting"
method: POST
path: "/engagementSettings"
tags: ["engagementSettings"]
---

# Create an engagement setting

`POST /engagementSettings`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/engagementSettings`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/lumahealth/apis/rest-service/docs/engagementSettings/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- EngagementSettingRequestCreate
  - `_id` string: Luma's internal ID of an object.
  - `user` string: The ID of the root account user.
  - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
  - `createdBy` string: The ID of the user who created this object.
  - `updatedBy` string: The ID of the user who updated this object.
  - `createdAt` string, date-time: The date/time when this object was created.
  - `updatedAt` string, date-time: The date/time when this object was updated.
  - `name` string, required: Name of this engagement setting preset.
  - `language` 'en-US' | 'es-US' | 'es-ES', required: The language the assistant should use for engagements using this preset.
  - `voice` string, required: The voice the assistant should use for engagements using this preset.

## Response `201`

Successful creation

- EngagementSettingResponse: An EngagementSetting is a small, reusable, named preset, made up of a language and a voice, that can be attached to an Engagement to configure how a voice or conversational engagement should sound and speak.
  - `_id` string: Luma's internal ID of an object.
  - `user` string: The ID of the root account user.
  - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
  - `createdBy` string: The ID of the user who created this object.
  - `updatedBy` string: The ID of the user who updated this object.
  - `createdAt` string, date-time: The date/time when this object was created.
  - `updatedAt` string, date-time: The date/time when this object was updated.
  - `name` string: Name of this engagement setting preset.
  - `language` 'en-US' | 'es-US' | 'es-ES': The language the assistant should use for engagements using this preset.
  - `voice` string: The voice the assistant should use for engagements using this preset.

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)