---
title: "Create ScheduledEventConfiguration"
method: POST
path: "/organizations/{orgId}/scheduledevents/configurations"
tags: ["ScheduledEventConfigurations"]
---

# Create ScheduledEventConfiguration

`POST /organizations/{orgId}/scheduledevents/configurations`

## Request

- Base URL: `https://api.m3ter.com`
- URL: `https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations`
- Auth: OAuth 2
  - Authorization code: `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize`, token URL `https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token`
  - Client credentials, token URL `/oauth/token`
- TypeScript: <https://skmtc.dev/m3ter-com/apis/m3ter-api/docs/organizations/:orgId/scheduledevents/configurations/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new ScheduledEventConfiguration.

## Path parameters

- `orgId` string, required

## Request body

- ScheduledEventConfigurationRequest
  - `version` integer: The version number of the entity: - **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response. - **Update Entity:** On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.

## Response `200`

Return the created ScheduledEventConfiguration

- ScheduledEventConfigurationResponse: Response containing a ScheduledEventConfiguration entity
  - `id` string, required: The UUID of the entity.
  - `version` integer: The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
  - `dtCreated` string, date-time: The DateTime when this item was created *(in ISO-8601 format)*.
  - `dtLastModified` string, date-time: The DateTime when this item was last modified *(in ISO-8601 format)*.
  - `createdBy` string: The ID of the user who created this item.
  - `lastModifiedBy` string: The ID of the user who last modified this item.
  - `name` string, required: The name of the custom Scheduled Event Configuration.
  - `entity` string, required: The referenced configuration or billing entity for which the desired scheduled Event will trigger.
  - `field` string, required: A DateTime field for which the desired scheduled Event will trigger - this must be a DateTime field on the referenced billing or configuration entity.
  - `offset` integer, required: The offset in days from the specified DateTime field on the referenced entity when the scheduled Event will trigger.

## Other responses

- `4XX`: Error message
- `5XX`: Error message

## Changes

- **2026-10-16** `85c514abc692`: 2 breaking
  - the `allOf[#/components/schemas/AbstractResponseWithAuditFields]/allOf[subschema #2]/` response's property type changed from no type to `object` for status `200`
  - the `allOf[subschema #3]/` response's property type changed from no type to `object` for status `200`
- **2025-08-29** `0f92c877619f`: 1 breaking, 1 warning
  - added `#/components/schemas/AbstractRequest` to the request body `allOf` list
  - removed the request property `version`
- **2025-08-01** `9f9e5f3dbde7`: 2 breaking
  - the response property `allOf[#/components/schemas/AbstractResponseWithAuditFields]/allOf[#/components/schemas/AbstractResponse]/version` became optional for the status `200`
  - the response property `allOf[#/components/schemas/AbstractResponse]/version` became optional for the status `200`

[Operation history](https://skmtc.dev/m3ter-com/apis/m3ter-api/changes/organizations/:orgId/scheduledevents/configurations/post.md)

---

[API](https://skmtc.dev/m3ter-com/apis/m3ter-api.md) - [All operations](https://skmtc.dev/m3ter-com/apis/m3ter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/m3ter-com/apis/m3ter-api/revisions/85c514abc692?raw)