Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
ScheduledEventConfigurations

Update ScheduledEventConfiguration

Update a ScheduledEventConfiguration for the given UUID.

put/organizations/{orgId}/scheduledevents/configurations/{id}

Path parameters

orgIdstring required

UUID of the organization

idstring required

The UUID of the ScheduledEventConfiguration to update.

Request body

versioninteger

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

Return the updated ScheduledEventConfiguration

idstring required

The UUID of the entity.

versioninteger

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.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

namestring required

The name of the custom Scheduled Event Configuration.

entitystring required

The referenced configuration or billing entity for which the desired scheduled Event will trigger.

fieldstring 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.

offsetinteger required

The offset in days from the specified DateTime field on the referenced entity when the scheduled Event will trigger.

Example response

{
  "name": "10 days after bill due date",
  "entity": "Bill",
  "field": "dueDate",
  "offset": 10
}