PUT api/v1/portals/{portalUid}/customer/registeredbodies/{registeredBodyGuid}

Updates the registered body by the specified registered body UID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalUid

The customer portal

globally unique identifier

Required

registeredBodyGuid

The registered body UID.

globally unique identifier

Required

Body Parameters

The registered body.

RegisteredBody
NameDescriptionTypeAdditional information
Name

The registered body name.

string

Required

String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1"
}

application/xml, text/xml

Sample:
<RegisteredBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Name>sample string 1</Name>
</RegisteredBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the updated registered body.

RegisteredBodyViewModel
NameDescriptionTypeAdditional information
Name

The registered body name.

string

None.

Portal

The portal.

PortalViewModel

None.

RegisteredBodyGuid

The unique identifier for the registered body

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",
  "Portal": {
    "Name": "sample string 1",
    "Uid": "3af3eb14-87df-4b5f-a90d-97d022223cfb",
    "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-12-21T17:49:19.0931348+00:00",
    "UpdatedBy": "sample string 3"
  },
  "RegisteredBodyGuid": "01c03fa7-619e-493c-a2f0-0425848ee543",
  "Uid": "a2c70028-1910-49d3-85f4-96af3f769f71",
  "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-12-21T17:49:19.0931348+00:00",
  "UpdatedBy": "sample string 4"
}

application/xml, text/xml

Sample:
<RegisteredBodyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-12-21T17:49:19.0931348+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>a2c70028-1910-49d3-85f4-96af3f769f71</Uid>
  <UpdatedBy>sample string 4</UpdatedBy>
  <Name>sample string 1</Name>
  <Portal>
    <DateUpdated>2025-12-21T17:49:19.0931348+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>3af3eb14-87df-4b5f-a90d-97d022223cfb</Uid>
    <UpdatedBy>sample string 3</UpdatedBy>
    <Name>sample string 1</Name>
  </Portal>
  <RegisteredBodyGuid>01c03fa7-619e-493c-a2f0-0425848ee543</RegisteredBodyGuid>
</RegisteredBodyViewModel>