PUT api/v1/agents/contacts/{agentContactUid}

Updates the agent contact with the specified agent contact UID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agentContactUid

The agent contact UID.

globally unique identifier

Required

Body Parameters

The agent contact.

AgentContact
NameDescriptionTypeAdditional information
Forename

The agent contact forename.

string

String length: inclusive between 0 and 100

Surname

The agent contact surname.

string

String length: inclusive between 0 and 100

JobTitle

The agent contact job title.

string

String length: inclusive between 0 and 100

Telephone

The agent contact telephone number.

string

String length: inclusive between 0 and 100

Mobile

The agent contact mobile telephone number.

string

String length: inclusive between 0 and 100

Email

The agent contact email address.

string

String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:
{
  "Forename": "sample string 1",
  "Surname": "sample string 2",
  "JobTitle": "sample string 3",
  "Telephone": "sample string 4",
  "Mobile": "sample string 5",
  "Email": "sample string 6"
}

application/xml, text/xml

Sample:
<AgentContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Email>sample string 6</Email>
  <Forename>sample string 1</Forename>
  <JobTitle>sample string 3</JobTitle>
  <Mobile>sample string 5</Mobile>
  <Surname>sample string 2</Surname>
  <Telephone>sample string 4</Telephone>
</AgentContact>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the updated agent contact.

AgentContactViewModel
NameDescriptionTypeAdditional information
Forename

The forename of the agent contact.

string

None.

Surname

The surname of the agent contact.

string

None.

JobTitle

The job title of the agent contact.

string

None.

Telephone

The telehone number for the agent contact.

string

None.

Mobile

The mobile telephone number for the agent contact.

string

None.

Email

The email address for the agent contact.

string

None.

Agent

Gets or sets the agent.

AgentViewModel

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:
{
  "Forename": "sample string 1",
  "Surname": "sample string 2",
  "JobTitle": "sample string 3",
  "Telephone": "sample string 4",
  "Mobile": "sample string 5",
  "Email": "sample string 6",
  "Agent": {
    "Portal": {
      "Name": "sample string 1",
      "Uid": "b8f649cb-bee9-4eb2-a602-e37771b92140",
      "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:59:05.318334+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": "b8f649cb-bee9-4eb2-a602-e37771b92140",
          "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:59:05.318334+00:00",
          "UpdatedBy": "sample string 3"
        },
        "CountryGuid": "5a1ddcb3-2870-4dd3-9939-8fd228743126",
        "Uid": "26ea77b6-b6d6-4b71-aa6e-c5b6cf7025b1",
        "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:59:05.318334+00:00",
        "UpdatedBy": "sample string 5"
      },
      "Latitude": "sample string 7",
      "Longitude": "sample string 8",
      "PortalUid": "3799edb8-aadf-4e02-849f-d0575fddd386",
      "PortalGuid": "d8e59e3c-ac2b-489d-bd56-938484b17a07",
      "CompanyGuid": "34e33466-eac7-45a1-a597-40b3490598d5",
      "Uid": "840da95d-e63f-48c4-a6e7-2b08838d1b21",
      "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:59:05.318334+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": "b8f649cb-bee9-4eb2-a602-e37771b92140",
        "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:59:05.318334+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "5a1ddcb3-2870-4dd3-9939-8fd228743126",
      "Uid": "26ea77b6-b6d6-4b71-aa6e-c5b6cf7025b1",
      "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:59:05.318334+00:00",
      "UpdatedBy": "sample string 5"
    },
    "AgencyKey": "sample string 7",
    "Uid": "d3b26ac6-77b0-43dd-a34c-39fbe2bc5c4e",
    "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:59:05.318334+00:00",
    "UpdatedBy": "sample string 9"
  },
  "Uid": "6a0f7b27-722f-4edb-a4c9-388ecdd1ef8b",
  "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:59:05.318334+00:00",
  "UpdatedBy": "sample string 8"
}

application/xml, text/xml

Sample:
<AgentContactViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:59:05.318334+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>6a0f7b27-722f-4edb-a4c9-388ecdd1ef8b</Uid>
  <UpdatedBy>sample string 8</UpdatedBy>
  <Agent>
    <DateUpdated>2025-10-27T13:59:05.318334+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>d3b26ac6-77b0-43dd-a34c-39fbe2bc5c4e</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:59:05.318334+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>840da95d-e63f-48c4-a6e7-2b08838d1b21</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>34e33466-eac7-45a1-a597-40b3490598d5</CompanyGuid>
      <Country>
        <DateUpdated>2025-10-27T13:59:05.318334+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>26ea77b6-b6d6-4b71-aa6e-c5b6cf7025b1</Uid>
        <UpdatedBy>sample string 5</UpdatedBy>
        <CountryGuid>5a1ddcb3-2870-4dd3-9939-8fd228743126</CountryGuid>
        <Iso3Code>sample string 1</Iso3Code>
        <Name>sample string 2</Name>
        <Portal>
          <DateUpdated>2025-10-27T13:59:05.318334+00:00</DateUpdated>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
          </Links>
          <Uid>b8f649cb-bee9-4eb2-a602-e37771b92140</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>d8e59e3c-ac2b-489d-bd56-938484b17a07</PortalGuid>
      <PortalUid>3799edb8-aadf-4e02-849f-d0575fddd386</PortalUid>
      <PostCode>sample string 6</PostCode>
    </Company>
    <Country>
      <DateUpdated>2025-10-27T13:59:05.318334+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>26ea77b6-b6d6-4b71-aa6e-c5b6cf7025b1</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>5a1ddcb3-2870-4dd3-9939-8fd228743126</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T13:59:05.318334+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>b8f649cb-bee9-4eb2-a602-e37771b92140</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Name>sample string 1</Name>
    <Portal>
      <DateUpdated>2025-10-27T13:59:05.318334+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>b8f649cb-bee9-4eb2-a602-e37771b92140</Uid>
      <UpdatedBy>sample string 3</UpdatedBy>
      <Name>sample string 1</Name>
    </Portal>
    <PostCode>sample string 6</PostCode>
  </Agent>
  <Email>sample string 6</Email>
  <Forename>sample string 1</Forename>
  <JobTitle>sample string 3</JobTitle>
  <Mobile>sample string 5</Mobile>
  <Surname>sample string 2</Surname>
  <Telephone>sample string 4</Telephone>
</AgentContactViewModel>