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>e19c8a1d-b8df-4e16-bd19-7e363fa512dd</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>8ddf2651-228c-4ca1-947b-a6377b27cdb6</PrimaryOrganizationID> <PrimaryTitle>sample string 10</PrimaryTitle> <PrimaryReportsTo>296f7f4b-1c68-4ae6-947e-7497a0b8ade8</PrimaryReportsTo> <UserName>sample string 11</UserName> <Password>sample string 12</Password> <ParentID>7918d234-c63a-4b70-add6-11a44676ba32</ParentID> <Deleted>false</Deleted> <DeletedByRef>false</DeletedByRef> <UserEmail>sample string 19</UserEmail> <HireDate>2025-02-04T22:33:25.0994534+00:00</HireDate> </Individual>
{ "ID": "e19c8a1d-b8df-4e16-bd19-7e363fa512dd", "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": "8ddf2651-228c-4ca1-947b-a6377b27cdb6", "PrimaryTitle": "sample string 10", "PrimaryReportsTo": "296f7f4b-1c68-4ae6-947e-7497a0b8ade8", "UserName": "sample string 11", "Password": "sample string 12", "ParentID": "7918d234-c63a-4b70-add6-11a44676ba32", "Deleted": false, "DeletedByRef": false, "UserEmail": "sample string 19", "HireDate": "2025-02-04T22:33:25.0994534+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>383b2d1f-d98a-4c96-993e-60823d764e27</ID> <SiteID>2e7e3717-417e-4f28-9198-7692f7d80f65</SiteID> <IsAdmin>true</IsAdmin> <UserID>3ac53426-40a3-4f56-8864-aa0ba3e780de</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>f46404bf-1818-4dfc-ae14-1e306becb178</PrimaryOrganizationID> <PrimaryTitle>sample string 10</PrimaryTitle> <PrimaryReportsTo>cd106491-63b4-4f1c-a28d-118e27831d93</PrimaryReportsTo> <UserName>sample string 11</UserName> <Password>sample string 12</Password> <ParentID>1e22e386-bd99-47b2-a417-ba74e5bb0057</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-02-04T22:33:25.0994534+00:00</Created> <CreatedBy>af204a56-76cc-4c29-98f9-5b2e350c9775</CreatedBy> <Updated>2025-02-04T22:33:25.0994534+00:00</Updated> <UpdatedBy>a4c19e44-2685-4dd5-86d3-809d5befd2a6</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-02-04T22:33:25.0994534Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>2040ac67-5938-4d12-990e-fcc527a2d6f9</LastCommentByID> <LastCommentBy>sample string 21</LastCommentBy> <CanRead>true</CanRead> <CanUpdate>true</CanUpdate> <CanDelete>true</CanDelete> <CanDelegate>true</CanDelegate> <SendEvalSurvey>true</SendEvalSurvey> <HireDate>2025-02-04T22:33:25.0994534+00:00</HireDate> </Individual>
{ "ID": "383b2d1f-d98a-4c96-993e-60823d764e27", "SiteID": "2e7e3717-417e-4f28-9198-7692f7d80f65", "IsAdmin": true, "UserID": "3ac53426-40a3-4f56-8864-aa0ba3e780de", "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": "f46404bf-1818-4dfc-ae14-1e306becb178", "PrimaryTitle": "sample string 10", "PrimaryReportsTo": "cd106491-63b4-4f1c-a28d-118e27831d93", "UserName": "sample string 11", "Password": "sample string 12", "ParentID": "1e22e386-bd99-47b2-a417-ba74e5bb0057", "PrimaryOrganizationName": "sample string 13", "FullName": "sample string 14", "FormalName": "sample string 15", "FullOrderedName": "sample string 16", "Deleted": true, "DeletedByRef": true, "Created": "2025-02-04T22:33:25.0994534+00:00", "CreatedBy": "af204a56-76cc-4c29-98f9-5b2e350c9775", "Updated": "2025-02-04T22:33:25.0994534+00:00", "UpdatedBy": "a4c19e44-2685-4dd5-86d3-809d5befd2a6", "IsGlobalAdmin": true, "UserEmail": "sample string 19", "LastComment": "sample string 20", "LastCommentDate": "2025-02-04T22:33:25.0994534+00:00", "LastCommentByID": "2040ac67-5938-4d12-990e-fcc527a2d6f9", "LastCommentBy": "sample string 21", "CanRead": true, "CanUpdate": true, "CanDelete": true, "CanDelegate": true, "SendEvalSurvey": true, "HireDate": "2025-02-04T22:33:25.0994534+00:00" }