POST Api/v{apiVersion}/CampaignBudgets

Creates a new campaignbudget

Request Information

URI Parameters

Name	Description	Type	Additional information
apiVersion		string	None.

Body Parameters

CampaignBudgetValues

Name	Type	Additional information
CampaignID	globally unique identifier	None.
StoreID	globally unique identifier	None.
Amount	decimal number	None.
Notes	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignID": "1c41d038-1e04-4b9d-974c-3c7a51a0e53a",
  "StoreID": "f8d1f7a8-f892-420f-be7e-8ba3dbea0a9e",
  "Amount": 2.1,
  "Notes": "sample string 3"
}

application/xml, text/xml

Sample:

<CampaignBudgetValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <Amount>2.1</Amount>
  <CampaignID>1c41d038-1e04-4b9d-974c-3c7a51a0e53a</CampaignID>
  <Notes>sample string 3</Notes>
  <StoreID>f8d1f7a8-f892-420f-be7e-8ba3dbea0a9e</StoreID>
</CampaignBudgetValues>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CampaignID"

1c41d038-1e04-4b9d-974c-3c7a51a0e53a
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StoreID"

f8d1f7a8-f892-420f-be7e-8ba3dbea0a9e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Amount"

2.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

CampaignBudgetDetails

Name	Type	Additional information
CampaignBudgetID	globally unique identifier	None.
Campaign	CampaignPreview	None.
Store	StorePreview	None.
Amount	decimal number	None.
IsGeneral	boolean	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CampaignBudgetID": "e32104c8-99a2-42b7-ac02-e5427460a831",
  "Campaign": {
    "CampaignID": "cc519c74-436b-4644-b971-2263830bb2eb",
    "Customer": {
      "CustomerID": "d8e9586f-037b-401c-ae28-cb9871509e8d",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "Address": "sample string 4",
      "City": {
        "AreaID": "9423a93b-5810-43e0-a270-b2c061ca0506",
        "ParentID": "2e2245f9-cf4f-4593-996b-f5668b434cbc",
        "ParentName": "sample string 2",
        "SupplierName": "sample string 3",
        "CustomerName": "sample string 4",
        "StoreName": "sample string 5",
        "Code": "sample string 6",
        "Name": "sample string 7",
        "Type": "Neighbourhood",
        "Status": "InActive",
        "OwnerName": "sample string 8",
        "Population": 9,
        "Mailboxes": 10
      },
      "Postcode": "sample string 5",
      "IsBackendCustomer": true,
      "Contact": "sample string 7",
      "PhoneNumber": "sample string 8"
    },
    "Name": "sample string 2",
    "Type": "NoInformation",
    "Status": "InActive",
    "StartDate": "2026-01-15T14:14:17.1266814Z",
    "EndDate": "2026-01-15T14:14:17.1266814Z",
    "IsRunning": true,
    "IsOrderingAllowed": true,
    "NumberOfOrders": 7,
    "TotalBudgetAmount": 1.1,
    "TotalSpentAmount": 8.1
  },
  "Store": {
    "StoreID": "223b78da-e34e-445b-8bb2-23c00a84e613",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Customer": {
      "CustomerID": "d8e9586f-037b-401c-ae28-cb9871509e8d",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "Address": "sample string 4",
      "City": {
        "AreaID": "9423a93b-5810-43e0-a270-b2c061ca0506",
        "ParentID": "2e2245f9-cf4f-4593-996b-f5668b434cbc",
        "ParentName": "sample string 2",
        "SupplierName": "sample string 3",
        "CustomerName": "sample string 4",
        "StoreName": "sample string 5",
        "Code": "sample string 6",
        "Name": "sample string 7",
        "Type": "Neighbourhood",
        "Status": "InActive",
        "OwnerName": "sample string 8",
        "Population": 9,
        "Mailboxes": 10
      },
      "Postcode": "sample string 5",
      "IsBackendCustomer": true,
      "Contact": "sample string 7",
      "PhoneNumber": "sample string 8"
    },
    "Status": "InActive",
    "Address": "sample string 4",
    "City": {
      "AreaID": "9423a93b-5810-43e0-a270-b2c061ca0506",
      "ParentID": "2e2245f9-cf4f-4593-996b-f5668b434cbc",
      "ParentName": "sample string 2",
      "SupplierName": "sample string 3",
      "CustomerName": "sample string 4",
      "StoreName": "sample string 5",
      "Code": "sample string 6",
      "Name": "sample string 7",
      "Type": "Neighbourhood",
      "Status": "InActive",
      "OwnerName": "sample string 8",
      "Population": 9,
      "Mailboxes": 10
    },
    "Postcode": "sample string 5",
    "Contact": "sample string 6",
    "PhoneNumber": "sample string 7",
    "MarketAreaName": "sample string 8",
    "IsAttentionNeeded": true
  },
  "Amount": 2.1,
  "IsGeneral": true,
  "Notes": "sample string 4",
  "CreatedAt": "2026-01-15T14:14:17.1266814Z",
  "CreatedBy": "sample string 6",
  "ModifiedAt": "2026-01-15T14:14:17.1266814Z",
  "ModifiedBy": "sample string 8"
}

application/xml, text/xml

Sample:

<CampaignBudgetDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <Amount>2.1</Amount>
  <Campaign>
    <CampaignID>cc519c74-436b-4644-b971-2263830bb2eb</CampaignID>
    <Customer>
      <Address>sample string 4</Address>
      <City>
        <AreaID>9423a93b-5810-43e0-a270-b2c061ca0506</AreaID>
        <Code>sample string 6</Code>
        <CustomerName>sample string 4</CustomerName>
        <Mailboxes>10</Mailboxes>
        <Name>sample string 7</Name>
        <OwnerName>sample string 8</OwnerName>
        <ParentID>2e2245f9-cf4f-4593-996b-f5668b434cbc</ParentID>
        <ParentName>sample string 2</ParentName>
        <Population>9</Population>
        <Status>InActive</Status>
        <StoreName>sample string 5</StoreName>
        <SupplierName>sample string 3</SupplierName>
        <Type>Neighbourhood</Type>
      </City>
      <Contact>sample string 7</Contact>
      <CustomerID>d8e9586f-037b-401c-ae28-cb9871509e8d</CustomerID>
      <IsBackendCustomer>true</IsBackendCustomer>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Postcode>sample string 5</Postcode>
      <Status>InActive</Status>
    </Customer>
    <EndDate>2026-01-15T15:14:17.1266814+01:00</EndDate>
    <IsOrderingAllowed>true</IsOrderingAllowed>
    <IsRunning>true</IsRunning>
    <Name>sample string 2</Name>
    <NumberOfOrders>7</NumberOfOrders>
    <StartDate>2026-01-15T15:14:17.1266814+01:00</StartDate>
    <Status>InActive</Status>
    <TotalBudgetAmount>1.1</TotalBudgetAmount>
    <TotalSpentAmount>8.1</TotalSpentAmount>
    <Type>NoInformation</Type>
  </Campaign>
  <CampaignBudgetID>e32104c8-99a2-42b7-ac02-e5427460a831</CampaignBudgetID>
  <CreatedAt>2026-01-15T15:14:17.1266814+01:00</CreatedAt>
  <CreatedBy>sample string 6</CreatedBy>
  <IsGeneral>true</IsGeneral>
  <ModifiedAt>2026-01-15T15:14:17.1266814+01:00</ModifiedAt>
  <ModifiedBy>sample string 8</ModifiedBy>
  <Notes>sample string 4</Notes>
  <Store>
    <Address>sample string 4</Address>
    <City>
      <AreaID>9423a93b-5810-43e0-a270-b2c061ca0506</AreaID>
      <Code>sample string 6</Code>
      <CustomerName>sample string 4</CustomerName>
      <Mailboxes>10</Mailboxes>
      <Name>sample string 7</Name>
      <OwnerName>sample string 8</OwnerName>
      <ParentID>2e2245f9-cf4f-4593-996b-f5668b434cbc</ParentID>
      <ParentName>sample string 2</ParentName>
      <Population>9</Population>
      <Status>InActive</Status>
      <StoreName>sample string 5</StoreName>
      <SupplierName>sample string 3</SupplierName>
      <Type>Neighbourhood</Type>
    </City>
    <Contact>sample string 6</Contact>
    <Customer>
      <Address>sample string 4</Address>
      <City>
        <AreaID>9423a93b-5810-43e0-a270-b2c061ca0506</AreaID>
        <Code>sample string 6</Code>
        <CustomerName>sample string 4</CustomerName>
        <Mailboxes>10</Mailboxes>
        <Name>sample string 7</Name>
        <OwnerName>sample string 8</OwnerName>
        <ParentID>2e2245f9-cf4f-4593-996b-f5668b434cbc</ParentID>
        <ParentName>sample string 2</ParentName>
        <Population>9</Population>
        <Status>InActive</Status>
        <StoreName>sample string 5</StoreName>
        <SupplierName>sample string 3</SupplierName>
        <Type>Neighbourhood</Type>
      </City>
      <Contact>sample string 7</Contact>
      <CustomerID>d8e9586f-037b-401c-ae28-cb9871509e8d</CustomerID>
      <IsBackendCustomer>true</IsBackendCustomer>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Postcode>sample string 5</Postcode>
      <Status>InActive</Status>
    </Customer>
    <IsAttentionNeeded>true</IsAttentionNeeded>
    <MarketAreaName>sample string 8</MarketAreaName>
    <Name>sample string 3</Name>
    <ParentName>sample string 2</ParentName>
    <PhoneNumber>sample string 7</PhoneNumber>
    <Postcode>sample string 5</Postcode>
    <Status>InActive</Status>
    <StoreID>223b78da-e34e-445b-8bb2-23c00a84e613</StoreID>
  </Store>
</CampaignBudgetDetails>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CampaignBudgetID"

e32104c8-99a2-42b7-ac02-e5427460a831
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.CampaignID"

cc519c74-436b-4644-b971-2263830bb2eb
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.CustomerID"

d8e9586f-037b-401c-ae28-cb9871509e8d
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.AreaID"

9423a93b-5810-43e0-a270-b2c061ca0506
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.ParentID"

2e2245f9-cf4f-4593-996b-f5668b434cbc
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.Contact"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Customer.PhoneNumber"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Type"

NoInformation
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.StartDate"

2026-01-15T15:14:17.1266814+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.EndDate"

2026-01-15T15:14:17.1266814+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.IsRunning"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.IsOrderingAllowed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.NumberOfOrders"

7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.TotalBudgetAmount"

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Campaign.TotalSpentAmount"

8.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.StoreID"

223b78da-e34e-445b-8bb2-23c00a84e613
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.CustomerID"

d8e9586f-037b-401c-ae28-cb9871509e8d
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.AreaID"

9423a93b-5810-43e0-a270-b2c061ca0506
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.ParentID"

2e2245f9-cf4f-4593-996b-f5668b434cbc
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.IsBackendCustomer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.Contact"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Customer.PhoneNumber"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Address"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.AreaID"

9423a93b-5810-43e0-a270-b2c061ca0506
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.ParentID"

2e2245f9-cf4f-4593-996b-f5668b434cbc
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.OwnerName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Population"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.City.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.Contact"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.PhoneNumber"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.MarketAreaName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Store.IsAttentionNeeded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Amount"

2.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsGeneral"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-01-15T15:14:17.1266814+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-01-15T15:14:17.1266814+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e--