GET v1/bunits/{bunitId}/activityreportsubscriptions

Get all activity report subscriptions of a business unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId ID of the business the subscriptions are related to integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of activity report subscription related to the business unit

ActivityReportSubscription
NameDescriptionTypeAdditional information
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.

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

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.

Emails Recipient email addresses.
Collection of string

None.

DecimalMark string

None.

DateFormat string

None.

TimeFormat string

None.

BusinessUnit BusinessUnit

None.

DateTimeFormat string

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.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.