PUT api/v1/organizations/{code}/updateCompanySubscriptionPlan

Request Information

URI Parameters

NameDescriptionTypeAdditional information
code

string

None.

Body Parameters

SubscriptionPlanDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

Code

string

None.

MaxCommunicationRecipients

integer

None.

AllowExportData

boolean

None.

MaxCampaigns

integer

None.

RecipientOverrideCost

decimal number

None.

ChangeCost

decimal number

None.

CampaignProgrammingAllowed

boolean

None.

CampaignTypeCategories

Collection of CampaignTypeCategoryDto

None.

SubscriptionPlanAutoCommunicationConfigsDto

Collection of SubscriptionPlanAutoCommunicationConfigDto

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "30a44451-7680-4b64-9a0c-ea7aa41e3019",
  "name": "sample string 2",
  "code": "sample string 3",
  "maxCommunicationRecipients": 4,
  "allowExportData": true,
  "maxCampaigns": 6,
  "recipientOverrideCost": 7.0,
  "changeCost": 8.0,
  "campaignProgrammingAllowed": true,
  "campaignTypeCategories": [
    {
      "id": "1e5fad7b-2a89-4de8-9cbc-c787c53520e3",
      "code": "sample string 1",
      "name": "sample string 2"
    },
    {
      "id": "1e5fad7b-2a89-4de8-9cbc-c787c53520e3",
      "code": "sample string 1",
      "name": "sample string 2"
    }
  ],
  "subscriptionPlanAutoCommunicationConfigsDto": [
    {
      "subscriptionPlanId": "8328b81c-b3bf-49ff-bf7c-bea846024a08",
      "autoCommunicationConfigCode": "sample string 2"
    },
    {
      "subscriptionPlanId": "8328b81c-b3bf-49ff-bf7c-bea846024a08",
      "autoCommunicationConfigCode": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<SubscriptionPlanDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Dtos">
  <AllowExportData>true</AllowExportData>
  <CampaignProgrammingAllowed>true</CampaignProgrammingAllowed>
  <CampaignTypeCategories>
    <CampaignTypeCategoryDto>
      <Code>sample string 1</Code>
      <Id>1e5fad7b-2a89-4de8-9cbc-c787c53520e3</Id>
      <Name>sample string 2</Name>
    </CampaignTypeCategoryDto>
    <CampaignTypeCategoryDto>
      <Code>sample string 1</Code>
      <Id>1e5fad7b-2a89-4de8-9cbc-c787c53520e3</Id>
      <Name>sample string 2</Name>
    </CampaignTypeCategoryDto>
  </CampaignTypeCategories>
  <ChangeCost>8</ChangeCost>
  <Code>sample string 3</Code>
  <Id>30a44451-7680-4b64-9a0c-ea7aa41e3019</Id>
  <MaxCampaigns>6</MaxCampaigns>
  <MaxCommunicationRecipients>4</MaxCommunicationRecipients>
  <Name>sample string 2</Name>
  <RecipientOverrideCost>7</RecipientOverrideCost>
  <SubscriptionPlanAutoCommunicationConfigsDto>
    <SubscriptionPlanAutoCommunicationConfigDto>
      <AutoCommunicationConfigCode>sample string 2</AutoCommunicationConfigCode>
      <SubscriptionPlanId>8328b81c-b3bf-49ff-bf7c-bea846024a08</SubscriptionPlanId>
    </SubscriptionPlanAutoCommunicationConfigDto>
    <SubscriptionPlanAutoCommunicationConfigDto>
      <AutoCommunicationConfigCode>sample string 2</AutoCommunicationConfigCode>
      <SubscriptionPlanId>8328b81c-b3bf-49ff-bf7c-bea846024a08</SubscriptionPlanId>
    </SubscriptionPlanAutoCommunicationConfigDto>
  </SubscriptionPlanAutoCommunicationConfigsDto>
</SubscriptionPlanDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.