POST api/v1/portals/{portalUid}/customer/referralsources

Creates the referral source.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal UID.	globally unique identifier	Required

Body Parameters

The referral source.

ReferralSource

Name	Description	Type	Additional information
Code	The code for the referral source	string	Required String length: inclusive between 0 and 6
Name	The name of the referral source.	string	Required String length: inclusive between 0 and 100
Description	The referral source description	string	Required String length: inclusive between 0 and 200
Company	The company we are creating this source within If no company is set eclipse will default to the first company in the portal	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Company": "49589fee-da79-480d-8cae-9c601467cf04"
}

application/xml, text/xml

Sample:

<ReferralSource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Code>sample string 1</Code>
  <Company>49589fee-da79-480d-8cae-9c601467cf04</Company>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
</ReferralSource>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created referral source.

ReferralSourceViewModel

Name	Description	Type	Additional information
Name	The name.	string	None.
Description	The description.	string	None.
Code	The description.	string	None.
ReferralSourceGuid	The unique identifier for the referral source	globally unique identifier	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Code": "sample string 3",
  "ReferralSourceGuid": "d2f15d2d-8218-4c8b-ac3e-fb3093ed73fa",
  "Uid": "c56935c2-48f1-484b-b800-73cf0d5c94fa",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T13:58:05.3689935+00:00",
  "UpdatedBy": "sample string 6"
}

application/xml, text/xml

Sample:

<ReferralSourceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:58:05.3689935+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>c56935c2-48f1-484b-b800-73cf0d5c94fa</Uid>
  <UpdatedBy>sample string 6</UpdatedBy>
  <Code>sample string 3</Code>
  <Description>sample string 2</Description>
  <Name>sample string 1</Name>
  <ReferralSourceGuid>d2f15d2d-8218-4c8b-ac3e-fb3093ed73fa</ReferralSourceGuid>
</ReferralSourceViewModel>