PATCH v1/bunits/{bunitId}/exportDataSubscriptions/{exportDataSubscriptionId}?deliveryConfigId={deliveryConfigId}

Overwrites the resource's property values with the values specified in the delta object.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId ID of the business unit the subscription is related to integer

Required

deliveryConfigId ID of the subscription to update integer

Required

exportDataSubscriptionId string

None.

Body Parameters

The subscription to update

ExportDataSubscription

Request Formats

application/json, text/json

Sample:

Sample not available.

Response Information

Resource Description

ExportDataSubscription
NameDescriptionTypeAdditional information
BusinessUnit Id of the business unit data is related to
BusinessUnit

None.

Enabled An enabled subscription will be sent out
Disable to keep information but avoid getting mails
boolean

None.

Name Name of subscription. Used to describe content
string

None.

Subject Custom subject set by end user. Leave blank for default subject
string

None.

Emails Recipient email addresses.
Collection of string

None.

SendBcc Whether or not to use BCC or To when sending emails.
Use BCC to hide receivers from each other
boolean

None.

ExportDataType The type of export to send
string

None.

Frequency How often the report should be sent
Types: Daily, Weekly, Monthly
Frequency

None.

FrequencyDetails A list of days if FrequencyType is weekly or monthly
if frequency is weekly valid options are 0 to 6 where 0 represents sunday and 6 represents saturday
if frequency is monthly valid options are 1 to 31 where values n represents last day of the month if no more than n days are in the month
Collection of integer

None.

Format The format data is presented in
string

None.

Server Some exports concern servers, and adding one can filter the result
Server

None.

NumberOfDays Some data may be related to a time span. Define how many days the span should include
integer

None.

DataViewConfigs Information about what collumns to include in data
Collection of DataViewConfig

None.

DecimalMark string

None.

DateFormat string

None.

TimeFormat string

None.

DateFormatInitialized string

None.

TimeFormatInitialized string

None.

DateTimeFormat string

None.

LatestDelivery SubscriptionLog

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Operations Collection of OperationResult

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.