Update an individual.
|
id
globally unique identifier
Required
Guid ID of the individual to be updated. |
|
tz
string
Optional parameter to set time zone information. |
This object takes all the parameters needed to update an individual.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList|
ID
globally unique identifier
Required on Update
ID of the given individual. |
|
SiteID
globally unique identifier
ReadOnly
ID of the site for the given individual. |
|
IsAdmin
boolean
Administrator setting for the given individual. |
|
UserID
globally unique identifier
ReadOnly
User ID of the given individual. |
|
Prefix
string
Prefix of the given individual's name. (Max length 25 characters) |
|
Suffix
string
Suffix of the given individual's name. (Max length 25 characters) |
|
FirstName
string
Required
First name of the given individual. (Max length 50 characters) |
|
LastName
string
Required
Last name of the given individual. (Max length 50 characters) |
|
UserDefined1
string
User defined field one. (Max length 255 characters) |
|
UserDefined2
string
User defined field two. (Max length 255 characters) |
|
UserDefined3
string
User defined field three. (Max length 255 characters) |
|
UserDefined4
string
User defined field four. (Max length 255 characters) |
|
Email
string
Required on Create
Email address of the given individual. (Max length 255 characters) |
|
PrimaryOrganizationID
globally unique identifier
Required on Create
ID of the primary organization of the given individual. |
|
PrimaryTitle
string
Required on Create
Title of the given individual. (Max length 255 characters) |
|
PrimaryReportsTo
globally unique identifier
Required on Create
ID of the primary reports to person for the given individual. |
|
UserName
string
Required
User name of the given individual. (Max length 255 characters) |
|
Password
string
Password of the given individual(Used for create and update). (This varible has been Deprecated and may be removed at a later date.) |
|
ParentID
globally unique identifier
Required on Create
Deprecated, this is no longer used and is always null. |
|
PrimaryOrganizationName
string
ReadOnly
Name of the primary organization for the given individual. |
|
FullName
string
ReadOnly
Full name of the given individual. |
|
FormalName
string
ReadOnly
Formal name of the given individual. |
|
FullOrderedName
string
ReadOnly
Full ordered name of the given individual. |
|
Deleted
boolean
ReadOnly
Deleted status of the given individual. |
|
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the given individual. |
|
Created
date
ReadOnly
Date the given individual was created. |
|
CreatedBy
globally unique identifier
ReadOnly
ID of the person that created the given individual. |
|
Updated
date
ReadOnly
Date the given individual was last updated. |
|
UpdatedBy
globally unique identifier
ReadOnly
ID of the person that last updated the given individual. |
|
IsGlobalAdmin
boolean
ReadOnly
Global administrator setting for the given individual. |
|
UserEmail
string
Required on Create
User email address of the given individual. (This varible has been Deprecated and may be removed at a later date.) |
|
LastComment
string
ReadOnly
Body of the most recent comment for the given individual. |
|
LastCommentDate
date
ReadOnly
Date of the most recent comment for the given individual. |
|
LastCommentByID
globally unique identifier
ReadOnly
ID of the individual who created the most recent comment for the given individual. |
|
LastCommentBy
string
ReadOnly
Name of the individual who created the most recent comment for the given individual. |
|
CanRead
boolean
ReadOnly
Read security setting for the individual based on the current logged in user. |
|
CanUpdate
boolean
ReadOnly
Update security setting for the individual based on the current logged in user. |
|
CanDelete
boolean
ReadOnly
Delete security setting for the individual based on the current logged in user. |
|
CanDelegate
boolean
ReadOnly
Delegate security setting for the individual based on the current logged in user. |
|
SendEvalSurvey
boolean
ReadOnly
Send Individual Evaluation Surveys |
|
HireDate
date
Date the given Individual was hired. |
<Individual xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>18577bb1-1620-49e0-9dd9-f44c8ae63e44</ID> <IsAdmin>true</IsAdmin> <Prefix>sample string 1</Prefix> <Suffix>sample string 2</Suffix> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <UserDefined1>sample string 5</UserDefined1> <UserDefined2>sample string 6</UserDefined2> <UserDefined3>sample string 7</UserDefined3> <UserDefined4>sample string 8</UserDefined4> <Email>sample string 9</Email> <PrimaryOrganizationID>c9f8d12e-5e55-4154-861d-1a2ba884eaad</PrimaryOrganizationID> <PrimaryTitle>sample string 10</PrimaryTitle> <PrimaryReportsTo>a5d8d628-2d88-4acc-8ea1-c7eaaa304009</PrimaryReportsTo> <UserName>sample string 11</UserName> <Password>sample string 12</Password> <ParentID>7e71f74d-27a5-4c77-9f24-53912a13c409</ParentID> <Deleted>false</Deleted> <DeletedByRef>false</DeletedByRef> <UserEmail>sample string 19</UserEmail> <HireDate>2025-12-09T17:45:40.220029+00:00</HireDate> </Individual>
{
"ID": "18577bb1-1620-49e0-9dd9-f44c8ae63e44",
"IsAdmin": true,
"Prefix": "sample string 1",
"Suffix": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"UserDefined1": "sample string 5",
"UserDefined2": "sample string 6",
"UserDefined3": "sample string 7",
"UserDefined4": "sample string 8",
"Email": "sample string 9",
"PrimaryOrganizationID": "c9f8d12e-5e55-4154-861d-1a2ba884eaad",
"PrimaryTitle": "sample string 10",
"PrimaryReportsTo": "a5d8d628-2d88-4acc-8ea1-c7eaaa304009",
"UserName": "sample string 11",
"Password": "sample string 12",
"ParentID": "7e71f74d-27a5-4c77-9f24-53912a13c409",
"Deleted": false,
"DeletedByRef": false,
"UserEmail": "sample string 19",
"HireDate": "2025-12-09T17:45:40.220029+00:00"
}
|
ID
globally unique identifier
Required on Update
ID of the given individual. |
|
SiteID
globally unique identifier
ReadOnly
ID of the site for the given individual. |
|
IsAdmin
boolean
Administrator setting for the given individual. |
|
UserID
globally unique identifier
ReadOnly
User ID of the given individual. |
|
Prefix
string
Prefix of the given individual's name. (Max length 25 characters) |
|
Suffix
string
Suffix of the given individual's name. (Max length 25 characters) |
|
FirstName
string
Required
First name of the given individual. (Max length 50 characters) |
|
LastName
string
Required
Last name of the given individual. (Max length 50 characters) |
|
UserDefined1
string
User defined field one. (Max length 255 characters) |
|
UserDefined2
string
User defined field two. (Max length 255 characters) |
|
UserDefined3
string
User defined field three. (Max length 255 characters) |
|
UserDefined4
string
User defined field four. (Max length 255 characters) |
|
Email
string
Required on Create
Email address of the given individual. (Max length 255 characters) |
|
PrimaryOrganizationID
globally unique identifier
Required on Create
ID of the primary organization of the given individual. |
|
PrimaryTitle
string
Required on Create
Title of the given individual. (Max length 255 characters) |
|
PrimaryReportsTo
globally unique identifier
Required on Create
ID of the primary reports to person for the given individual. |
|
UserName
string
Required
User name of the given individual. (Max length 255 characters) |
|
Password
string
Password of the given individual(Used for create and update). (This varible has been Deprecated and may be removed at a later date.) |
|
ParentID
globally unique identifier
Required on Create
Deprecated, this is no longer used and is always null. |
|
PrimaryOrganizationName
string
ReadOnly
Name of the primary organization for the given individual. |
|
FullName
string
ReadOnly
Full name of the given individual. |
|
FormalName
string
ReadOnly
Formal name of the given individual. |
|
FullOrderedName
string
ReadOnly
Full ordered name of the given individual. |
|
Deleted
boolean
ReadOnly
Deleted status of the given individual. |
|
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the given individual. |
|
Created
date
ReadOnly
Date the given individual was created. |
|
CreatedBy
globally unique identifier
ReadOnly
ID of the person that created the given individual. |
|
Updated
date
ReadOnly
Date the given individual was last updated. |
|
UpdatedBy
globally unique identifier
ReadOnly
ID of the person that last updated the given individual. |
|
IsGlobalAdmin
boolean
ReadOnly
Global administrator setting for the given individual. |
|
UserEmail
string
Required on Create
User email address of the given individual. (This varible has been Deprecated and may be removed at a later date.) |
|
LastComment
string
ReadOnly
Body of the most recent comment for the given individual. |
|
LastCommentDate
date
ReadOnly
Date of the most recent comment for the given individual. |
|
LastCommentByID
globally unique identifier
ReadOnly
ID of the individual who created the most recent comment for the given individual. |
|
LastCommentBy
string
ReadOnly
Name of the individual who created the most recent comment for the given individual. |
|
CanRead
boolean
ReadOnly
Read security setting for the individual based on the current logged in user. |
|
CanUpdate
boolean
ReadOnly
Update security setting for the individual based on the current logged in user. |
|
CanDelete
boolean
ReadOnly
Delete security setting for the individual based on the current logged in user. |
|
CanDelegate
boolean
ReadOnly
Delegate security setting for the individual based on the current logged in user. |
|
SendEvalSurvey
boolean
ReadOnly
Send Individual Evaluation Surveys |
|
HireDate
date
Date the given Individual was hired. |
<Individual xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
<ID>5dadf4d3-8673-456a-b2bd-87c7dc7e9884</ID>
<SiteID>42b48fd1-e7e4-430e-8673-31382f83645c</SiteID>
<IsAdmin>true</IsAdmin>
<UserID>5830c97f-a96f-49e6-acfe-291067018e25</UserID>
<Prefix>sample string 1</Prefix>
<Suffix>sample string 2</Suffix>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<UserDefined1>sample string 5</UserDefined1>
<UserDefined2>sample string 6</UserDefined2>
<UserDefined3>sample string 7</UserDefined3>
<UserDefined4>sample string 8</UserDefined4>
<Email>sample string 9</Email>
<PrimaryOrganizationID>3aadcdf8-9916-44be-bc5d-0b38884dab2a</PrimaryOrganizationID>
<PrimaryTitle>sample string 10</PrimaryTitle>
<PrimaryReportsTo>a16f4f08-4e49-4982-ba92-53a843ac8278</PrimaryReportsTo>
<UserName>sample string 11</UserName>
<Password>sample string 12</Password>
<ParentID>ed786d5f-8beb-4124-82d0-709f22a888cf</ParentID>
<PrimaryOrganizationName>sample string 13</PrimaryOrganizationName>
<FullName>sample string 14</FullName>
<FormalName>sample string 15</FormalName>
<FullOrderedName>sample string 16</FullOrderedName>
<Deleted>true</Deleted>
<DeletedByRef>true</DeletedByRef>
<Created>2025-12-09T17:45:40.2332567+00:00</Created>
<CreatedBy>03567116-9183-4d24-a70c-c0163cf2c6f0</CreatedBy>
<Updated>2025-12-09T17:45:40.2332567+00:00</Updated>
<UpdatedBy>0e43c42c-cd17-48b1-9b1d-55c11b883a60</UpdatedBy>
<IsGlobalAdmin>true</IsGlobalAdmin>
<UserEmail>sample string 19</UserEmail>
<LastComment>sample string 20</LastComment>
<LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-09T17:45:40.2332567Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</LastCommentDate>
<LastCommentByID>7c71d009-cb85-48f2-8e69-59ec7046a96c</LastCommentByID>
<LastCommentBy>sample string 21</LastCommentBy>
<CanRead>true</CanRead>
<CanUpdate>true</CanUpdate>
<CanDelete>true</CanDelete>
<CanDelegate>true</CanDelegate>
<SendEvalSurvey>true</SendEvalSurvey>
<HireDate>2025-12-09T17:45:40.2332567+00:00</HireDate>
</Individual>
{
"ID": "5dadf4d3-8673-456a-b2bd-87c7dc7e9884",
"SiteID": "42b48fd1-e7e4-430e-8673-31382f83645c",
"IsAdmin": true,
"UserID": "5830c97f-a96f-49e6-acfe-291067018e25",
"Prefix": "sample string 1",
"Suffix": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"UserDefined1": "sample string 5",
"UserDefined2": "sample string 6",
"UserDefined3": "sample string 7",
"UserDefined4": "sample string 8",
"Email": "sample string 9",
"PrimaryOrganizationID": "3aadcdf8-9916-44be-bc5d-0b38884dab2a",
"PrimaryTitle": "sample string 10",
"PrimaryReportsTo": "a16f4f08-4e49-4982-ba92-53a843ac8278",
"UserName": "sample string 11",
"Password": "sample string 12",
"ParentID": "ed786d5f-8beb-4124-82d0-709f22a888cf",
"PrimaryOrganizationName": "sample string 13",
"FullName": "sample string 14",
"FormalName": "sample string 15",
"FullOrderedName": "sample string 16",
"Deleted": true,
"DeletedByRef": true,
"Created": "2025-12-09T17:45:40.2332567+00:00",
"CreatedBy": "03567116-9183-4d24-a70c-c0163cf2c6f0",
"Updated": "2025-12-09T17:45:40.2332567+00:00",
"UpdatedBy": "0e43c42c-cd17-48b1-9b1d-55c11b883a60",
"IsGlobalAdmin": true,
"UserEmail": "sample string 19",
"LastComment": "sample string 20",
"LastCommentDate": "2025-12-09T17:45:40.2332567+00:00",
"LastCommentByID": "7c71d009-cb85-48f2-8e69-59ec7046a96c",
"LastCommentBy": "sample string 21",
"CanRead": true,
"CanUpdate": true,
"CanDelete": true,
"CanDelegate": true,
"SendEvalSurvey": true,
"HireDate": "2025-12-09T17:45:40.2332567+00:00"
}