PUT api/v1/companies/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

CompanyDto

Name	Type	Additional information
Id	string	None.
Name	string	None.
Description	string	None.
Landing	LandingConfig	None.
Campaign	CampaignConfig	None.
Billing	BillingConfig	None.
CreatedAt	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Landing": {
    "PrimaryColor": "sample string 1",
    "WelcomeTitle": "sample string 2",
    "CustomFields": [
      {
        "Id": "sample string 1",
        "Label": "sample string 2",
        "Type": "sample string 3",
        "Options": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "Id": "sample string 1",
        "Label": "sample string 2",
        "Type": "sample string 3",
        "Options": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  "Campaign": {
    "RewardType": "sample string 1",
    "RewardValue": 2.0,
    "RewardDescription": "sample string 3"
  },
  "Billing": {
    "Model": "sample string 1",
    "FixedAmount": 2.0,
    "PerLeadAmount": 3.0,
    "RevenueSharePercent": 4.0
  },
  "CreatedAt": "2025-12-13T15:39:07.254381+01:00"
}

text/html

Sample:

{"Id":"sample string 1","Name":"sample string 2","Description":"sample string 3","Landing":{"PrimaryColor":"sample string 1","WelcomeTitle":"sample string 2","CustomFields":[{"Id":"sample string 1","Label":"sample string 2","Type":"sample string 3","Options":["sample string 1","sample string 2"]},{"Id":"sample string 1","Label":"sample string 2","Type":"sample string 3","Options":["sample string 1","sample string 2"]}]},"Campaign":{"RewardType":"sample string 1","RewardValue":2.0,"RewardDescription":"sample string 3"},"Billing":{"Model":"sample string 1","FixedAmount":2.0,"PerLeadAmount":3.0,"RevenueSharePercent":4.0},"CreatedAt":"2025-12-13T15:39:07.254381+01:00"}

application/xml, text/xml

Sample:

<CompanyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReferralFlowAPI.DTOs">
  <Billing>
    <FixedAmount>2</FixedAmount>
    <Model>sample string 1</Model>
    <PerLeadAmount>3</PerLeadAmount>
    <RevenueSharePercent>4</RevenueSharePercent>
  </Billing>
  <Campaign>
    <RewardDescription>sample string 3</RewardDescription>
    <RewardType>sample string 1</RewardType>
    <RewardValue>2</RewardValue>
  </Campaign>
  <CreatedAt>2025-12-13T15:39:07.254381+01:00</CreatedAt>
  <Description>sample string 3</Description>
  <Id>sample string 1</Id>
  <Landing>
    <CustomFields>
      <CustomField>
        <Id>sample string 1</Id>
        <Label>sample string 2</Label>
        <Options xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Options>
        <Type>sample string 3</Type>
      </CustomField>
      <CustomField>
        <Id>sample string 1</Id>
        <Label>sample string 2</Label>
        <Options xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Options>
        <Type>sample string 3</Type>
      </CustomField>
    </CustomFields>
    <PrimaryColor>sample string 1</PrimaryColor>
    <WelcomeTitle>sample string 2</WelcomeTitle>
  </Landing>
  <Name>sample string 2</Name>
</CompanyDto>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CompanyDto'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.