PUT basicroles/{basicRoleid}/dialogs/{dialogid}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
basicRoleid `globally unique identifier` Required Guid ID of the basic role for which to update the dialog.	`globally unique identifier` Required Guid ID of the basic role for which to update the dialog.
dialogid `globally unique identifier` Required Guid ID of the dialog to be updated.	`globally unique identifier` Required Guid ID of the dialog to be updated.

Body Parameters (BasicRoleDialog)

This object takes all the parameters needed to update a basic role dialog.

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
BasicRoleID `globally unique identifier` Required ID of the given basic role.	`globally unique identifier` Required ID of the given basic role.
DialogID `globally unique identifier` Required ID of the given dialog.	`globally unique identifier` Required ID of the given dialog.
Description `string` Required Description of the given dialog.	`string` Required Description of the given dialog.
BasicRoleName `string` ReadOnly Name of the given basic role.	`string` ReadOnly Name of the given basic role.
BasicRoleRank `integer` ReadOnly Rank of the given basic role.	`integer` ReadOnly Rank of the given basic role.
DialogDate `date` ReadOnly Date and time of the given dialog.	`date` ReadOnly Date and time of the given dialog.

Request Formats

application/xml, text/xml

Sample

<BasicRoleDialog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <BasicRoleID>adbe7427-2304-414e-b18f-523ce5d36f09</BasicRoleID>
  <DialogID>d3994b34-8f35-42e4-9fd1-660f152cb273</DialogID>
  <Description>sample string 1</Description>
</BasicRoleDialog>

application/json, text/json

Sample

{
  "BasicRoleID": "adbe7427-2304-414e-b18f-523ce5d36f09",
  "DialogID": "d3994b34-8f35-42e4-9fd1-660f152cb273",
  "Description": "sample string 1"
}

Response Information

Resource Description (BasicRoleDialog)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
BasicRoleID `globally unique identifier` Required ID of the given basic role.	`globally unique identifier` Required ID of the given basic role.
DialogID `globally unique identifier` Required ID of the given dialog.	`globally unique identifier` Required ID of the given dialog.
Description `string` Required Description of the given dialog.	`string` Required Description of the given dialog.
BasicRoleName `string` ReadOnly Name of the given basic role.	`string` ReadOnly Name of the given basic role.
BasicRoleRank `integer` ReadOnly Rank of the given basic role.	`integer` ReadOnly Rank of the given basic role.
DialogDate `date` ReadOnly Date and time of the given dialog.	`date` ReadOnly Date and time of the given dialog.

Response Formats

application/xml, text/xml

Sample

<BasicRoleDialog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <BasicRoleID>efec1f68-675f-4ab5-89c3-e69ffe7b0ce1</BasicRoleID>
  <DialogID>e991df2b-b867-418f-a618-a6a2709b5f09</DialogID>
  <Description>sample string 1</Description>
  <BasicRoleName>sample string 2</BasicRoleName>
  <BasicRoleRank>1</BasicRoleRank>
  <DialogDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-07-27T21:01:08.640941Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DialogDate>
</BasicRoleDialog>

application/json, text/json

Sample

{
  "BasicRoleID": "efec1f68-675f-4ab5-89c3-e69ffe7b0ce1",
  "DialogID": "e991df2b-b867-418f-a618-a6a2709b5f09",
  "Description": "sample string 1",
  "BasicRoleName": "sample string 2",
  "BasicRoleRank": 1,
  "DialogDate": "2026-07-27T21:01:08.640941+00:00"
}