Account8

AccountPlan5

Aggregation5

Auth1

BalanceChargeSchedule6

Balances8

BalanceTransactionSchedule6

Bill19

BillConfig2

BillGroupingKey5

BillJob5

Charge5

Commitments6

CompoundAggregation5

Contract6

Counter5

CounterAdjustments5

CounterPricing5

CreditReason5

Credits5

Currency5

CustomField2

DataExplorer1

DataExplorerV26

DebitReason5

Debits5

Events4

ExportAdHoc1

ExportDestination6

ExportJob2

ExportSchedule5

External Mapping10

Integrations24

Invitations3

Line Item1

LookupTable5

LookupTableRevision6

LookupTableRevisionData13

Marketplace Integrations1

Measurements6

Meter5

Notifications6

OrganizationConfig2

OrgUsers6

PermissionPolicy13

Plan5

PlanGroup5

PlanGroupLink5

PlanTemplate5

Pricing5

Product5

ResourceGroup9

ScheduledEventConfigurations5

StatementDefinition5

StatementJob5

Support2

TransactionType5

User1

ExportSchedule

Update Schedule

Update a Data Export Schedule for the given UUID. Each Schedule can be configured for exporting only one of either Usage or Operational data:

Operational Data Exports.

Use the operationalDataTypes parameter to specify the entities whose operational data you want to include in the export each time the Export Schedule runs.
For each of the entity types you select, each time the Export Schedule runs a separate file is compiled containing the operational data for all entities of that type that exist in your Organization

Usage Data Exports.

Select the Meters and Accounts whose usage data you want to include in the export each time the Export Schedule runs.
You can use the dimensionFilters parameter to filter the usage data returned for export by adding specific values of non-numeric Dimension data fields on included Meters. Only the data collected for the values you've added for the selected Dimension fields will be included in the export.
You can use the aggregations to apply aggregation methods the usage data returned for export. This restricts the range of usage data returned for export to only the data collected by aggregated fields on selected Meters. Nothing is returned for any non-aggregated fields on Meters. The usage data for Meter fields is returned as the values resulting from applying the selected aggregation method. See the Aggregations for Queries - Options and Consequences for more details.
If you've applied aggregations to the usage returned for export, you can then use the groups parameter to group the data by Account, Dimension, or Time.

put/organizations/{orgId}/dataexports/schedules/{id}

Path parameters

orgIdstring required

UUID of the organization

idstring required

The UUID of the Schedule to update.

Request body

Response

Returns the updated Export Schedule

Changes

Changed in 5 of the 10 revisions of this API.52217

Dec 3, 2025ac93d1a9e6d9217See the full diff
- ▲
  removed the enum value JSON of the request property ////////////
  request-property-enum-value-removed
- ▲
  removed the enum value JSON of the request property ////////////
  request-property-enum-value-removed
- ●
  added the new CHARGES enum value to the ///// response property for the response status
  response-property-enum-value-added
- ○
  added the new CHARGES enum value to the request property /////
  request-property-enum-value-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  removed the JSON enum value from the //////////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the JSON enum value from the //////////// response property for the response status
  response-property-enum-value-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 1, 20259f9e5f3dbde715See the full diff
- ▲
  removed from the request body oneOf list
  request-body-one-of-removed
- ○
  added to the request body anyOf list
  request-body-any-of-added
- ○
  mapped value for key USAGE changed from to from the request discriminator
  request-body-discriminator-mapping-changed
- ○
  added to the response body anyOf list for the response status
  response-body-any-of-added
- ○
  mapped value for key USAGE changed from to from the response discriminator for the response status
  response-body-discriminator-mapping-changed
- ○
  removed from the response body oneOf list for the response status
  response-body-one-of-removed
This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 26, 20256c3e1a3cfb8f2203See the full diff
- ▲
  the request's body type changed from object to no type
  request-body-type-changed
- ▲
  the response's body type changed from object to no type for status
  response-body-type-changed
- ●
  removed from the request body allOf list
  request-body-all-of-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added request discriminator
  request-body-discriminator-added
- ○
  removed from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  added response discriminator for the response status
  response-body-discriminator-added
Feb 21, 2025d064a12d0d9311See the full diff
- ●
  added the new BALANCE_TRANSACTIONS enum value to the ///// response property for the response status
  response-property-enum-value-added
- ○
  added the new BALANCE_TRANSACTIONS enum value to the request property /////
  request-property-enum-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 20259433593378b51See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history