POST Subscribers
Request Information
URI Parameters
None.
Body Parameters
vwEffectiveConfiguration3Name | 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 : 2025-06-07 03:08\r\nModified: Unknown : \r\nDeleted: Unknown : ", "CreatedByAndTime": "Unknown : 2025-06-07 03:08", "ModifiedByAndTime": "Unknown : ", "DeletedByAndTime": "Unknown : ", "effectiveNextBillingDate": "2025-06-07T03:08:58.5478186+00:00", "InstallationID": "55264afd-3a7a-494e-b382-441e41e9ca45", "InstallationName": "sample string 2", "InstallationDescription": "sample string 3", "DatabaseName": "sample string 4", "InstallationEmailBatchSize": 5, "InstallationEmailUseAsync": true, "InstallationEmailSendingActive": true, "OwnerUser": "sample string 8", "OwnerMasterUserID": "b1c6b751-81fc-4098-a718-3d6b173d3358", "FinanceContactMasterUserID": "950376aa-fdac-4d15-99cd-2f573c57ab9a", "InstallationAdminMasterUserID": "1ef7a3b6-9511-4d45-b442-337f384994d5", "InstallationFreeTrialUntil": "2025-06-07T03:08:58.5458972+00:00", "InstallationLastBillingDate": "2025-06-07T03:08:58.5468934+00:00", "InstallationNextBillingDate": "2025-06-07T03:08:58.5478186+00:00", "CreatedDate": "2025-06-07T03:08:58.5478186+00:00", "InstallationEmailUseTracker": true, "InstallationStatusName": "sample string 11", "DiscountSchemeTitle": "sample string 12", "DiscountSchemeDescription": "sample string 13", "DiscountSchemeStartDate": "2025-06-07T03:08:58.5488859+00:00", "DiscountSchemeEndDate": "2025-06-07T03:08:58.5498854+00:00", "DiscountSchemeDiscount": 1.0, "DiscountSchemeAbsoluteDiscountMonthly": 1.0, "DiscountSchemeMaximumAmount": 1.0, "DiscountSchemeDefaultLengthMonths": 1, "InstallationLastUsageStatDateTime": "2025-06-07T03:08:58.5518802+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": "77beb320-c0f7-4299-b422-ed08df3ef8f7", "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": "d157c9be-b46e-48d4-b0d1-70f5efa8ff28", "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": "8dffcac2-7d21-474c-8c6e-42ebeca387fa", "Expr1": "sample string 43", "RunMagsMessagingServiceID": "0dcfad82-7bcc-481c-b069-44841ab8ac35", "RunMagsClientUrlID": "b31847f5-2811-48e5-bf9f-e81ca67428f1", "RunMagsClientUrl": "sample string 44", "RunMagsAccountingServiceID": "2627ffaa-088b-479b-bdba-43d86c5cabd0", "Expr2": "sample string 45", "AccountingServiceURL": "sample string 46", "InstallationMassEmailMergeEnabled": true, "DiscountSchemePrepaidMonths": 1, "Installation2ID": "b4d2dba8-53a5-4fae-94f0-9937434d44c0" }
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>2025-06-07T03:08:58.5478186+00:00</CreatedDate> <DatabaseID>8dffcac2-7d21-474c-8c6e-42ebeca387fa</DatabaseID> <DatabaseName>sample string 4</DatabaseName> <DiscountSchemeAbsoluteDiscountMonthly>1</DiscountSchemeAbsoluteDiscountMonthly> <DiscountSchemeDefaultLengthMonths>1</DiscountSchemeDefaultLengthMonths> <DiscountSchemeDescription>sample string 13</DiscountSchemeDescription> <DiscountSchemeDiscount>1</DiscountSchemeDiscount> <DiscountSchemeEndDate>2025-06-07T03:08:58.5498854+00:00</DiscountSchemeEndDate> <DiscountSchemeMaximumAmount>1</DiscountSchemeMaximumAmount> <DiscountSchemePrepaidMonths>1</DiscountSchemePrepaidMonths> <DiscountSchemeStartDate>2025-06-07T03:08:58.5488859+00:00</DiscountSchemeStartDate> <DiscountSchemeTitle>sample string 12</DiscountSchemeTitle> <EffectiveConnectionString>sample string 22</EffectiveConnectionString> <Expr1>sample string 43</Expr1> <Expr2>sample string 45</Expr2> <FinanceContactMasterUserID>950376aa-fdac-4d15-99cd-2f573c57ab9a</FinanceContactMasterUserID> <Installation2ID>b4d2dba8-53a5-4fae-94f0-9937434d44c0</Installation2ID> <InstallationAbsoluteDiscount>1</InstallationAbsoluteDiscount> <InstallationAcountingServiceEnabled>true</InstallationAcountingServiceEnabled> <InstallationAddonAbsoluteDiscount>1</InstallationAddonAbsoluteDiscount> <InstallationAddonDiscountText>sample string 35</InstallationAddonDiscountText> <InstallationAddonPercentageDiscount>1</InstallationAddonPercentageDiscount> <InstallationAdminMasterUserID>1ef7a3b6-9511-4d45-b442-337f384994d5</InstallationAdminMasterUserID> <InstallationDefaultMailFromDomainID>d157c9be-b46e-48d4-b0d1-70f5efa8ff28</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>2025-06-07T03:08:58.5458972+00:00</InstallationFreeTrialUntil> <InstallationID>55264afd-3a7a-494e-b382-441e41e9ca45</InstallationID> <InstallationLastBillingDate>2025-06-07T03:08:58.5468934+00:00</InstallationLastBillingDate> <InstallationLastUsageStatDateTime>2025-06-07T03:08:58.5518802+00:00</InstallationLastUsageStatDateTime> <InstallationMassEmailEnabled>true</InstallationMassEmailEnabled> <InstallationMassEmailMergeEnabled>true</InstallationMassEmailMergeEnabled> <InstallationName>sample string 2</InstallationName> <InstallationNextBillingDate>2025-06-07T03:08:58.5478186+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>b1c6b751-81fc-4098-a718-3d6b173d3358</OwnerMasterUserID> <OwnerUser>sample string 8</OwnerUser> <RunMagsAccountingServiceID>2627ffaa-088b-479b-bdba-43d86c5cabd0</RunMagsAccountingServiceID> <RunMagsAccountingServiceUrl>sample string 40</RunMagsAccountingServiceUrl> <RunMagsClientUrl>sample string 44</RunMagsClientUrl> <RunMagsClientUrlID>b31847f5-2811-48e5-bf9f-e81ca67428f1</RunMagsClientUrlID> <RunMagsDatabaseServerUrl>sample string 42</RunMagsDatabaseServerUrl> <RunMagsMessagingServiceID>0dcfad82-7bcc-481c-b069-44841ab8ac35</RunMagsMessagingServiceID> <RunMagsMessagingServiceUrl>sample string 39</RunMagsMessagingServiceUrl> <RunMagsWebWorkerUrl>sample string 41</RunMagsWebWorkerUrl> <ServerDescription>sample string 25</ServerDescription> <ServerID>77beb320-c0f7-4299-b422-ed08df3ef8f7</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>