POST v1/bunits/{bunitId}/statusconsumptionunitdeliveryconfig
Create a status report delivery config for a business unit
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
ID of the business unit the config should be related to | integer |
Required |
Body Parameters
The config to create
StatusReportConsumptionUnitDeliveryConfigName | Description | Type | Additional information |
---|---|---|---|
Subject |
The subsject of the mail to send |
string |
None. |
Message |
The message included in the body of the mail to send |
string |
None. |
Inherited |
Whether configuration is inherited from an ancestor business unit. |
boolean |
None. |
IncludeStatusOk |
boolean |
None. |
|
IncludeStatusOkWithWarnings |
boolean |
None. |
|
IncludeStatusWarning |
boolean |
None. |
|
IncludeStatusError |
boolean |
None. |
|
IncludeStatusIgnored |
boolean |
None. |
|
IncludeStatusPending |
boolean |
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. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<StatusReportConsumptionUnitDeliveryConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>10</Id> <CreatedDate>2024-09-17T20:27:03.368313+02:00</CreatedDate> <ArchivedDate>2024-09-17T20:27:03.368313+02:00</ArchivedDate> <Subject>sample string 1</Subject> <Message>sample string 2</Message> <Inherited>true</Inherited> <IncludeStatusOk>true</IncludeStatusOk> <IncludeStatusOkWithWarnings>true</IncludeStatusOkWithWarnings> <IncludeStatusWarning>true</IncludeStatusWarning> <IncludeStatusError>true</IncludeStatusError> <IncludeStatusIgnored>true</IncludeStatusIgnored> <IncludeStatusPending>true</IncludeStatusPending> </StatusReportConsumptionUnitDeliveryConfig>
Response Information
Resource Description
The created config
StatusReportConsumptionUnitDeliveryConfigName | Description | Type | Additional information |
---|---|---|---|
Subject |
The subsject of the mail to send |
string |
None. |
Message |
The message included in the body of the mail to send |
string |
None. |
Inherited |
Whether configuration is inherited from an ancestor business unit. |
boolean |
None. |
IncludeStatusOk |
boolean |
None. |
|
IncludeStatusOkWithWarnings |
boolean |
None. |
|
IncludeStatusWarning |
boolean |
None. |
|
IncludeStatusError |
boolean |
None. |
|
IncludeStatusIgnored |
boolean |
None. |
|
IncludeStatusPending |
boolean |
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.
application/xml, text/xml
Sample:
<StatusReportConsumptionUnitDeliveryConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>10</Id> <CreatedDate>2024-09-17T20:27:03.3837895+02:00</CreatedDate> <ArchivedDate>2024-09-17T20:27:03.3837895+02:00</ArchivedDate> <Subject>sample string 1</Subject> <Message>sample string 2</Message> <Inherited>true</Inherited> <IncludeStatusOk>true</IncludeStatusOk> <IncludeStatusOkWithWarnings>true</IncludeStatusOkWithWarnings> <IncludeStatusWarning>true</IncludeStatusWarning> <IncludeStatusError>true</IncludeStatusError> <IncludeStatusIgnored>true</IncludeStatusIgnored> <IncludeStatusPending>true</IncludeStatusPending> </StatusReportConsumptionUnitDeliveryConfig>