POST api/v1/portals/{portalUid}/agents

Creates the agent by the specified portal UID.

Request Information

URI Parameters

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

Body Parameters

The agent.

Agent

Name	Description	Type	Additional information
Name	The agent name.	string	Required String length: inclusive between 0 and 100
AddressLine1	The agent address line1.	string	String length: inclusive between 0 and 100
AddressLine2	The agent address line2.	string	String length: inclusive between 0 and 100
AddressLine3	The agent address line3.	string	String length: inclusive between 0 and 100
AddressLine4	The agent address line4.	string	String length: inclusive between 0 and 100
PostCode	The agent post code.	string	String length: inclusive between 0 and 50
Country	The agent country.	globally unique identifier	None.
AgencyKey	Gets or sets the agency key.	string	Required String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "AddressLine1": "sample string 2",
  "AddressLine2": "sample string 3",
  "AddressLine3": "sample string 4",
  "AddressLine4": "sample string 5",
  "PostCode": "sample string 6",
  "Country": "96f4c1e8-c43f-4b9f-92b1-91a4b4cf728c",
  "AgencyKey": "sample string 8"
}

application/xml, text/xml

Sample:

<Agent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AddressLine1>sample string 2</AddressLine1>
  <AddressLine2>sample string 3</AddressLine2>
  <AddressLine3>sample string 4</AddressLine3>
  <AddressLine4>sample string 5</AddressLine4>
  <AgencyKey>sample string 8</AgencyKey>
  <Country>96f4c1e8-c43f-4b9f-92b1-91a4b4cf728c</Country>
  <Name>sample string 1</Name>
  <PostCode>sample string 6</PostCode>
</Agent>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created agent.

AgentViewModel

Name	Description	Type	Additional information
Portal	Gets or sets the portal.	PortalViewModel	None.
Company	Gets or sets the company.	CompanyViewModel	None.
Name	Gets or sets the name.	string	None.
Address1	Gets or sets the address1.	string	None.
Address2	Gets or sets the address2.	string	None.
Address3	Gets or sets the address3.	string	None.
Address4	Gets or sets the address4.	string	None.
PostCode	Gets or sets the post code.	string	None.
Country	Gets or sets the country.	CountryViewModel	None.
AgencyKey	Gets or sets the agency key.	string	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:

{
  "Portal": {
    "Name": "sample string 1",
    "Uid": "3518fa22-ade8-4fb7-bee0-8b5c604d2594",
    "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:23:39.783176+00:00",
    "UpdatedBy": "sample string 3"
  },
  "Company": {
    "Name": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "AddressLine3": "sample string 4",
    "AddressLine4": "sample string 5",
    "PostCode": "sample string 6",
    "Country": {
      "Iso3Code": "sample string 1",
      "Name": "sample string 2",
      "Portal": {
        "Name": "sample string 1",
        "Uid": "3518fa22-ade8-4fb7-bee0-8b5c604d2594",
        "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:23:39.783176+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "21bbffd4-3ee1-46cb-bd0c-4a30c002c281",
      "Uid": "2e5aec37-bc7a-4c6e-8e10-c580cf77aac5",
      "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:23:39.783176+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "0e6c9564-571a-46c5-bb40-3a68b8a3372e",
    "PortalGuid": "5fd44dff-1df8-4268-ab5d-ec2423b159cb",
    "CompanyGuid": "35aa342f-fb47-48df-9391-ffadfbeabd42",
    "Uid": "1c1548b9-8aa2-4440-9a87-fdfd4a8d91ee",
    "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:23:39.783176+00:00",
    "UpdatedBy": "sample string 13"
  },
  "Name": "sample string 1",
  "Address1": "sample string 2",
  "Address2": "sample string 3",
  "Address3": "sample string 4",
  "Address4": "sample string 5",
  "PostCode": "sample string 6",
  "Country": {
    "Iso3Code": "sample string 1",
    "Name": "sample string 2",
    "Portal": {
      "Name": "sample string 1",
      "Uid": "3518fa22-ade8-4fb7-bee0-8b5c604d2594",
      "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:23:39.783176+00:00",
      "UpdatedBy": "sample string 3"
    },
    "CountryGuid": "21bbffd4-3ee1-46cb-bd0c-4a30c002c281",
    "Uid": "2e5aec37-bc7a-4c6e-8e10-c580cf77aac5",
    "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:23:39.783176+00:00",
    "UpdatedBy": "sample string 5"
  },
  "AgencyKey": "sample string 7",
  "Uid": "c333ab73-c336-49b2-86cf-c0ffba75e629",
  "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:23:39.783176+00:00",
  "UpdatedBy": "sample string 9"
}

application/xml, text/xml

Sample:

<AgentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:23:39.783176+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>c333ab73-c336-49b2-86cf-c0ffba75e629</Uid>
  <UpdatedBy>sample string 9</UpdatedBy>
  <Address1>sample string 2</Address1>
  <Address2>sample string 3</Address2>
  <Address3>sample string 4</Address3>
  <Address4>sample string 5</Address4>
  <AgencyKey>sample string 7</AgencyKey>
  <Company>
    <DateUpdated>2025-10-27T13:23:39.783176+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>1c1548b9-8aa2-4440-9a87-fdfd4a8d91ee</Uid>
    <UpdatedBy>sample string 13</UpdatedBy>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <AddressLine3>sample string 4</AddressLine3>
    <AddressLine4>sample string 5</AddressLine4>
    <CompanyGuid>35aa342f-fb47-48df-9391-ffadfbeabd42</CompanyGuid>
    <Country>
      <DateUpdated>2025-10-27T13:23:39.783176+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>2e5aec37-bc7a-4c6e-8e10-c580cf77aac5</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>21bbffd4-3ee1-46cb-bd0c-4a30c002c281</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T13:23:39.783176+00:00</DateUpdated>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
        </Links>
        <Uid>3518fa22-ade8-4fb7-bee0-8b5c604d2594</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Latitude>sample string 7</Latitude>
    <Longitude>sample string 8</Longitude>
    <Name>sample string 1</Name>
    <PortalGuid>5fd44dff-1df8-4268-ab5d-ec2423b159cb</PortalGuid>
    <PortalUid>0e6c9564-571a-46c5-bb40-3a68b8a3372e</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <Country>
    <DateUpdated>2025-10-27T13:23:39.783176+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>2e5aec37-bc7a-4c6e-8e10-c580cf77aac5</Uid>
    <UpdatedBy>sample string 5</UpdatedBy>
    <CountryGuid>21bbffd4-3ee1-46cb-bd0c-4a30c002c281</CountryGuid>
    <Iso3Code>sample string 1</Iso3Code>
    <Name>sample string 2</Name>
    <Portal>
      <DateUpdated>2025-10-27T13:23:39.783176+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>3518fa22-ade8-4fb7-bee0-8b5c604d2594</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
  </Country>
  <Name>sample string 1</Name>
  <Portal>
    <DateUpdated>2025-10-27T13:23:39.783176+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>3518fa22-ade8-4fb7-bee0-8b5c604d2594</Uid>
    <UpdatedBy>sample string 3</UpdatedBy>
    <Name>sample string 1</Name>
  </Portal>
  <PostCode>sample string 6</PostCode>
</AgentViewModel>