POST Subscribers
Request Information
URI Parameters
None.
Body Parameters
vwEffectiveConfiguration3| Name | Description | Type | Additional information |
|---|---|---|---|
| InfoPopupText | string |
None. |
|
| CreatedByAndTime | string |
None. |
|
| ModifiedByAndTime | string |
None. |
|
| DeletedByAndTime | string |
None. |
|
| effectiveNextBillingDate | date |
None. |
|
| InstallationID | globally unique identifier |
None. |
|
| InstallationName | string |
None. |
|
| InstallationDescription | string |
None. |
|
| DatabaseName | string |
None. |
|
| InstallationEmailBatchSize | integer |
None. |
|
| InstallationEmailUseAsync | boolean |
None. |
|
| InstallationEmailSendingActive | boolean |
None. |
|
| OwnerUser | string |
None. |
|
| OwnerMasterUserID | globally unique identifier |
None. |
|
| FinanceContactMasterUserID | globally unique identifier |
None. |
|
| InstallationAdminMasterUserID | globally unique identifier |
None. |
|
| InstallationFreeTrialUntil | date |
None. |
|
| InstallationLastBillingDate | date |
None. |
|
| InstallationNextBillingDate | date |
None. |
|
| CreatedDate | date |
None. |
|
| InstallationEmailUseTracker | boolean |
None. |
|
| InstallationStatusName | string |
None. |
|
| DiscountSchemeTitle | string |
None. |
|
| DiscountSchemeDescription | string |
None. |
|
| DiscountSchemeStartDate | date |
None. |
|
| DiscountSchemeEndDate | date |
None. |
|
| DiscountSchemeDiscount | decimal number |
None. |
|
| DiscountSchemeAbsoluteDiscountMonthly | decimal number |
None. |
|
| DiscountSchemeMaximumAmount | decimal number |
None. |
|
| DiscountSchemeDefaultLengthMonths | integer |
None. |
|
| InstallationLastUsageStatDateTime | date |
None. |
|
| InstallationStripeAPIKey | string |
None. |
|
| InstallationStripeAPITestKey | string |
None. |
|
| InstallationStripeConnectAccessToken | string |
None. |
|
| InstallationStripeConnectLivemode | string |
None. |
|
| InstallationStripeConnectRefreshToken | string |
None. |
|
| InstallationStripeConnectPublishableKey | string |
None. |
|
| InstallationStripeConnectUserID | string |
None. |
|
| InstallationStripeConnectScope | string |
None. |
|
| EffectiveConnectionString | string |
None. |
|
| ServerName | string |
None. |
|
| ServerLocation | string |
None. |
|
| ServerDescription | string |
None. |
|
| ConnectionStringTemplate | string |
None. |
|
| StructureConnectionString | string |
None. |
|
| LoggingServiceURL | string |
None. |
|
| MessageServiceURL | string |
None. |
|
| WebWorkerURL | string |
None. |
|
| MessageServiceActive | boolean |
None. |
|
| ServerID | globally unique identifier |
None. |
|
| InstallationSendGridIP | string |
None. |
|
| InstallationSendGridDedicatedIP | boolean |
None. |
|
| InstallationSendGridDomain | string |
None. |
|
| InstallationSendGridActivated | boolean |
None. |
|
| InstallationSendGridOneTimeAllowance | integer |
None. |
|
| InstallationSendGridMonthlyAllowance | integer |
None. |
|
| InstallationSendGridPassword | string |
None. |
|
| InstallationSendGridSubUser | string |
None. |
|
| InstallationAddonDiscountText | string |
None. |
|
| InstallationAddonAbsoluteDiscount | decimal number |
None. |
|
| InstallationAddonPercentageDiscount | decimal number |
None. |
|
| InstallationDiscountText | string |
None. |
|
| InstallationPercentageDiscount | decimal number |
None. |
|
| InstallationAbsoluteDiscount | decimal number |
None. |
|
| InstallationAcountingServiceEnabled | boolean |
None. |
|
| InstallationDefaultSESConfigurationSet | string |
None. |
|
| InstallationDefaultMailFromDomainID | globally unique identifier |
None. |
|
| IsDeleted | boolean |
None. |
|
| InstallationService1Enabled | boolean |
None. |
|
| IntsallationService2Enabled | boolean |
None. |
|
| InstallationService3Enabled | boolean |
None. |
|
| InstallationMassEmailEnabled | boolean |
None. |
|
| RunMagsMessagingServiceUrl | string |
None. |
|
| RunMagsAccountingServiceUrl | string |
None. |
|
| RunMagsWebWorkerUrl | string |
None. |
|
| RunMagsDatabaseServerUrl | string |
None. |
|
| DatabaseID | globally unique identifier |
None. |
|
| Expr1 | string |
None. |
|
| RunMagsMessagingServiceID | globally unique identifier |
None. |
|
| RunMagsClientUrlID | globally unique identifier |
None. |
|
| RunMagsClientUrl | string |
None. |
|
| RunMagsAccountingServiceID | globally unique identifier |
None. |
|
| Expr2 | string |
None. |
|
| AccountingServiceURL | string |
None. |
|
| InstallationMassEmailMergeEnabled | boolean |
None. |
|
| DiscountSchemePrepaidMonths | integer |
None. |
|
| Installation2ID | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"InfoPopupText": "Created: Unknown : 2026-04-14 03:13\r\nModified: Unknown : \r\nDeleted: Unknown : ",
"CreatedByAndTime": "Unknown : 2026-04-14 03:13",
"ModifiedByAndTime": "Unknown : ",
"DeletedByAndTime": "Unknown : ",
"effectiveNextBillingDate": "2026-04-14T03:13:50.4171038+00:00",
"InstallationID": "ff34c7a9-e5a2-4a32-8041-f12bd70eef05",
"InstallationName": "sample string 2",
"InstallationDescription": "sample string 3",
"DatabaseName": "sample string 4",
"InstallationEmailBatchSize": 5,
"InstallationEmailUseAsync": true,
"InstallationEmailSendingActive": true,
"OwnerUser": "sample string 8",
"OwnerMasterUserID": "a93c2d2e-c216-41d9-9dd1-0e2bce217d6d",
"FinanceContactMasterUserID": "13dc5ce2-60d3-4c09-bd9f-cb2b334ae3c3",
"InstallationAdminMasterUserID": "283e0737-9cb4-4ca1-a205-4d76548416d8",
"InstallationFreeTrialUntil": "2026-04-14T03:13:50.4171038+00:00",
"InstallationLastBillingDate": "2026-04-14T03:13:50.4171038+00:00",
"InstallationNextBillingDate": "2026-04-14T03:13:50.4171038+00:00",
"CreatedDate": "2026-04-14T03:13:50.4181011+00:00",
"InstallationEmailUseTracker": true,
"InstallationStatusName": "sample string 11",
"DiscountSchemeTitle": "sample string 12",
"DiscountSchemeDescription": "sample string 13",
"DiscountSchemeStartDate": "2026-04-14T03:13:50.4190984+00:00",
"DiscountSchemeEndDate": "2026-04-14T03:13:50.4201152+00:00",
"DiscountSchemeDiscount": 1.0,
"DiscountSchemeAbsoluteDiscountMonthly": 1.0,
"DiscountSchemeMaximumAmount": 1.0,
"DiscountSchemeDefaultLengthMonths": 1,
"InstallationLastUsageStatDateTime": "2026-04-14T03:13:50.4220903+00:00",
"InstallationStripeAPIKey": "sample string 14",
"InstallationStripeAPITestKey": "sample string 15",
"InstallationStripeConnectAccessToken": "sample string 16",
"InstallationStripeConnectLivemode": "sample string 17",
"InstallationStripeConnectRefreshToken": "sample string 18",
"InstallationStripeConnectPublishableKey": "sample string 19",
"InstallationStripeConnectUserID": "sample string 20",
"InstallationStripeConnectScope": "sample string 21",
"EffectiveConnectionString": "sample string 22",
"ServerName": "sample string 23",
"ServerLocation": "sample string 24",
"ServerDescription": "sample string 25",
"ConnectionStringTemplate": "sample string 26",
"StructureConnectionString": "sample string 27",
"LoggingServiceURL": "sample string 28",
"MessageServiceURL": "sample string 29",
"WebWorkerURL": "sample string 30",
"MessageServiceActive": true,
"ServerID": "278d306f-7d56-457b-8b5f-7d995a4ef4d0",
"InstallationSendGridIP": "sample string 31",
"InstallationSendGridDedicatedIP": true,
"InstallationSendGridDomain": "sample string 32",
"InstallationSendGridActivated": true,
"InstallationSendGridOneTimeAllowance": 1,
"InstallationSendGridMonthlyAllowance": 1,
"InstallationSendGridPassword": "sample string 33",
"InstallationSendGridSubUser": "sample string 34",
"InstallationAddonDiscountText": "sample string 35",
"InstallationAddonAbsoluteDiscount": 1.0,
"InstallationAddonPercentageDiscount": 1.0,
"InstallationDiscountText": "sample string 36",
"InstallationPercentageDiscount": 1.0,
"InstallationAbsoluteDiscount": 1.0,
"InstallationAcountingServiceEnabled": true,
"InstallationDefaultSESConfigurationSet": "sample string 37",
"InstallationDefaultMailFromDomainID": "fc62cecd-6202-4ced-90b2-53434f754bba",
"IsDeleted": true,
"InstallationService1Enabled": true,
"IntsallationService2Enabled": true,
"InstallationService3Enabled": true,
"InstallationMassEmailEnabled": true,
"RunMagsMessagingServiceUrl": "sample string 39",
"RunMagsAccountingServiceUrl": "sample string 40",
"RunMagsWebWorkerUrl": "sample string 41",
"RunMagsDatabaseServerUrl": "sample string 42",
"DatabaseID": "cb0508fa-a9e0-4ea6-a049-61d84dfffa9a",
"Expr1": "sample string 43",
"RunMagsMessagingServiceID": "891818a1-dfa2-432d-a6ba-ef3bb759cf0a",
"RunMagsClientUrlID": "0d34a429-6cc1-4949-9e51-c1f374518198",
"RunMagsClientUrl": "sample string 44",
"RunMagsAccountingServiceID": "9dd427b3-4279-4cc5-b6d1-50a9e70f99c6",
"Expr2": "sample string 45",
"AccountingServiceURL": "sample string 46",
"InstallationMassEmailMergeEnabled": true,
"DiscountSchemePrepaidMonths": 1,
"Installation2ID": "2aa6c6a4-3fa5-4039-a8ef-ba40a9f03212"
}
application/xml, text/xml
Sample:
<vwEffectiveConfiguration3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RunMags.ClassLibrary"> <AccountingServiceURL>sample string 46</AccountingServiceURL> <ConnectionStringTemplate>sample string 26</ConnectionStringTemplate> <CreatedDate>2026-04-14T03:13:50.4181011+00:00</CreatedDate> <DatabaseID>cb0508fa-a9e0-4ea6-a049-61d84dfffa9a</DatabaseID> <DatabaseName>sample string 4</DatabaseName> <DiscountSchemeAbsoluteDiscountMonthly>1</DiscountSchemeAbsoluteDiscountMonthly> <DiscountSchemeDefaultLengthMonths>1</DiscountSchemeDefaultLengthMonths> <DiscountSchemeDescription>sample string 13</DiscountSchemeDescription> <DiscountSchemeDiscount>1</DiscountSchemeDiscount> <DiscountSchemeEndDate>2026-04-14T03:13:50.4201152+00:00</DiscountSchemeEndDate> <DiscountSchemeMaximumAmount>1</DiscountSchemeMaximumAmount> <DiscountSchemePrepaidMonths>1</DiscountSchemePrepaidMonths> <DiscountSchemeStartDate>2026-04-14T03:13:50.4190984+00:00</DiscountSchemeStartDate> <DiscountSchemeTitle>sample string 12</DiscountSchemeTitle> <EffectiveConnectionString>sample string 22</EffectiveConnectionString> <Expr1>sample string 43</Expr1> <Expr2>sample string 45</Expr2> <FinanceContactMasterUserID>13dc5ce2-60d3-4c09-bd9f-cb2b334ae3c3</FinanceContactMasterUserID> <Installation2ID>2aa6c6a4-3fa5-4039-a8ef-ba40a9f03212</Installation2ID> <InstallationAbsoluteDiscount>1</InstallationAbsoluteDiscount> <InstallationAcountingServiceEnabled>true</InstallationAcountingServiceEnabled> <InstallationAddonAbsoluteDiscount>1</InstallationAddonAbsoluteDiscount> <InstallationAddonDiscountText>sample string 35</InstallationAddonDiscountText> <InstallationAddonPercentageDiscount>1</InstallationAddonPercentageDiscount> <InstallationAdminMasterUserID>283e0737-9cb4-4ca1-a205-4d76548416d8</InstallationAdminMasterUserID> <InstallationDefaultMailFromDomainID>fc62cecd-6202-4ced-90b2-53434f754bba</InstallationDefaultMailFromDomainID> <InstallationDefaultSESConfigurationSet>sample string 37</InstallationDefaultSESConfigurationSet> <InstallationDescription>sample string 3</InstallationDescription> <InstallationDiscountText>sample string 36</InstallationDiscountText> <InstallationEmailBatchSize>5</InstallationEmailBatchSize> <InstallationEmailSendingActive>true</InstallationEmailSendingActive> <InstallationEmailUseAsync>true</InstallationEmailUseAsync> <InstallationEmailUseTracker>true</InstallationEmailUseTracker> <InstallationFreeTrialUntil>2026-04-14T03:13:50.4171038+00:00</InstallationFreeTrialUntil> <InstallationID>ff34c7a9-e5a2-4a32-8041-f12bd70eef05</InstallationID> <InstallationLastBillingDate>2026-04-14T03:13:50.4171038+00:00</InstallationLastBillingDate> <InstallationLastUsageStatDateTime>2026-04-14T03:13:50.4220903+00:00</InstallationLastUsageStatDateTime> <InstallationMassEmailEnabled>true</InstallationMassEmailEnabled> <InstallationMassEmailMergeEnabled>true</InstallationMassEmailMergeEnabled> <InstallationName>sample string 2</InstallationName> <InstallationNextBillingDate>2026-04-14T03:13:50.4171038+00:00</InstallationNextBillingDate> <InstallationPercentageDiscount>1</InstallationPercentageDiscount> <InstallationSendGridActivated>true</InstallationSendGridActivated> <InstallationSendGridDedicatedIP>true</InstallationSendGridDedicatedIP> <InstallationSendGridDomain>sample string 32</InstallationSendGridDomain> <InstallationSendGridIP>sample string 31</InstallationSendGridIP> <InstallationSendGridMonthlyAllowance>1</InstallationSendGridMonthlyAllowance> <InstallationSendGridOneTimeAllowance>1</InstallationSendGridOneTimeAllowance> <InstallationSendGridPassword>sample string 33</InstallationSendGridPassword> <InstallationSendGridSubUser>sample string 34</InstallationSendGridSubUser> <InstallationService1Enabled>true</InstallationService1Enabled> <InstallationService3Enabled>true</InstallationService3Enabled> <InstallationStatusName>sample string 11</InstallationStatusName> <InstallationStripeAPIKey>sample string 14</InstallationStripeAPIKey> <InstallationStripeAPITestKey>sample string 15</InstallationStripeAPITestKey> <InstallationStripeConnectAccessToken>sample string 16</InstallationStripeConnectAccessToken> <InstallationStripeConnectLivemode>sample string 17</InstallationStripeConnectLivemode> <InstallationStripeConnectPublishableKey>sample string 19</InstallationStripeConnectPublishableKey> <InstallationStripeConnectRefreshToken>sample string 18</InstallationStripeConnectRefreshToken> <InstallationStripeConnectScope>sample string 21</InstallationStripeConnectScope> <InstallationStripeConnectUserID>sample string 20</InstallationStripeConnectUserID> <IntsallationService2Enabled>true</IntsallationService2Enabled> <IsDeleted>true</IsDeleted> <LoggingServiceURL>sample string 28</LoggingServiceURL> <MessageServiceActive>true</MessageServiceActive> <MessageServiceURL>sample string 29</MessageServiceURL> <OwnerMasterUserID>a93c2d2e-c216-41d9-9dd1-0e2bce217d6d</OwnerMasterUserID> <OwnerUser>sample string 8</OwnerUser> <RunMagsAccountingServiceID>9dd427b3-4279-4cc5-b6d1-50a9e70f99c6</RunMagsAccountingServiceID> <RunMagsAccountingServiceUrl>sample string 40</RunMagsAccountingServiceUrl> <RunMagsClientUrl>sample string 44</RunMagsClientUrl> <RunMagsClientUrlID>0d34a429-6cc1-4949-9e51-c1f374518198</RunMagsClientUrlID> <RunMagsDatabaseServerUrl>sample string 42</RunMagsDatabaseServerUrl> <RunMagsMessagingServiceID>891818a1-dfa2-432d-a6ba-ef3bb759cf0a</RunMagsMessagingServiceID> <RunMagsMessagingServiceUrl>sample string 39</RunMagsMessagingServiceUrl> <RunMagsWebWorkerUrl>sample string 41</RunMagsWebWorkerUrl> <ServerDescription>sample string 25</ServerDescription> <ServerID>278d306f-7d56-457b-8b5f-7d995a4ef4d0</ServerID> <ServerLocation>sample string 24</ServerLocation> <ServerName>sample string 23</ServerName> <StructureConnectionString>sample string 27</StructureConnectionString> <WebWorkerURL>sample string 30</WebWorkerURL> </vwEffectiveConfiguration3>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>