POST api/v1/Offers
Create offer
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| offer |
Define this parameter in the request body. |
Request body formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"OfferID": 1,
"OfferType": "sample string 2",
"OfferName": "sample string 3",
"TransportMode": "sample string 4",
"Title": "sample string 5",
"Tier": "sample string 6",
"LinkUrl": "sample string 7",
"From": [
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
],
"To": [
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
],
"Images": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"WhitelistCountries": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"BlacklistCountries": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"ShortContent": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Created": null,
"Agent": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
},
"ContactEmail": "sample string 8",
"Validity": {
"From": "2025-04-25T13:59:45.6059728Z",
"To": "2025-04-25T13:59:45.6059728Z"
},
"HTML": "sample string 9",
"CustomWidget": "sample string 10",
"ImpressionCount": 11,
"InterestCount": 12,
"LeadCount": 13,
"RFQCount": 14
}
application/xml, text/xml
Sample:
<OfferDTO>
<OfferID>1</OfferID>
<OfferType>sample string 2</OfferType>
<OfferName>sample string 3</OfferName>
<TransportMode>sample string 4</TransportMode>
<Title>sample string 5</Title>
<Tier>sample string 6</Tier>
<LinkUrl>sample string 7</LinkUrl>
<From>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</From>
<From>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</From>
<From>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</From>
<To>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</To>
<To>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</To>
<To>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</To>
<Images>sample string 1</Images>
<Images>sample string 2</Images>
<Images>sample string 3</Images>
<WhitelistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</WhitelistCountries>
<WhitelistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</WhitelistCountries>
<WhitelistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</WhitelistCountries>
<BlacklistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</BlacklistCountries>
<BlacklistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</BlacklistCountries>
<BlacklistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</BlacklistCountries>
<ShortContent>sample string 1</ShortContent>
<ShortContent>sample string 2</ShortContent>
<ShortContent>sample string 3</ShortContent>
<Created />
<Agent>
<AgentID>1</AgentID>
<AgentName />
<ContactID>0</ContactID>
<ContactName />
</Agent>
<ContactEmail>sample string 8</ContactEmail>
<Validity>
<From>2025-04-25T13:59:45.6059728+00:00</From>
<To>2025-04-25T13:59:45.6059728+00:00</To>
</Validity>
<HTML>sample string 9</HTML>
<CustomWidget>sample string 10</CustomWidget>
<ImpressionCount>11</ImpressionCount>
<InterestCount>12</InterestCount>
<LeadCount>13</LeadCount>
<RFQCount>14</RFQCount>
</OfferDTO>
Response Information
Response body formats
application/json, text/json
Sample:
{
"OfferID": 1,
"OfferType": "sample string 2",
"OfferName": "sample string 3",
"TransportMode": "sample string 4",
"Title": "sample string 5",
"Tier": "sample string 6",
"LinkUrl": "sample string 7",
"From": [
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
],
"To": [
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
},
{
"LocationType": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3"
}
],
"Images": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"WhitelistCountries": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"BlacklistCountries": [
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
},
{
"Code": "sample string 1",
"Name": "sample string 2"
}
],
"ShortContent": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Created": null,
"Agent": {
"AgentID": 1,
"AgentIDAsText": "1",
"AgentName": null,
"ContactID": 0,
"ContactIDAsText": "0",
"ContactName": null,
"Datetime": null,
"DatetimeAsText": null
},
"ContactEmail": "sample string 8",
"Validity": {
"From": "2025-04-25T13:59:45.6684735Z",
"To": "2025-04-25T13:59:45.6684735Z"
},
"HTML": "sample string 9",
"CustomWidget": "sample string 10",
"ImpressionCount": 11,
"InterestCount": 12,
"LeadCount": 13,
"RFQCount": 14
}
application/xml, text/xml
Sample:
<OfferDTO>
<OfferID>1</OfferID>
<OfferType>sample string 2</OfferType>
<OfferName>sample string 3</OfferName>
<TransportMode>sample string 4</TransportMode>
<Title>sample string 5</Title>
<Tier>sample string 6</Tier>
<LinkUrl>sample string 7</LinkUrl>
<From>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</From>
<From>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</From>
<From>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</From>
<To>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</To>
<To>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</To>
<To>
<Code>sample string 2</Code>
<Name>sample string 3</Name>
<LocationType>sample string 1</LocationType>
</To>
<Images>sample string 1</Images>
<Images>sample string 2</Images>
<Images>sample string 3</Images>
<WhitelistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</WhitelistCountries>
<WhitelistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</WhitelistCountries>
<WhitelistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</WhitelistCountries>
<BlacklistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</BlacklistCountries>
<BlacklistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</BlacklistCountries>
<BlacklistCountries>
<Code>sample string 1</Code>
<Name>sample string 2</Name>
</BlacklistCountries>
<ShortContent>sample string 1</ShortContent>
<ShortContent>sample string 2</ShortContent>
<ShortContent>sample string 3</ShortContent>
<Created />
<Agent>
<AgentID>1</AgentID>
<AgentName />
<ContactID>0</ContactID>
<ContactName />
</Agent>
<ContactEmail>sample string 8</ContactEmail>
<Validity>
<From>2025-04-25T13:59:45.6684735+00:00</From>
<To>2025-04-25T13:59:45.6684735+00:00</To>
</Validity>
<HTML>sample string 9</HTML>
<CustomWidget>sample string 10</CustomWidget>
<ImpressionCount>11</ImpressionCount>
<InterestCount>12</InterestCount>
<LeadCount>13</LeadCount>
<RFQCount>14</RFQCount>
</OfferDTO>