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>0bc7aaf8-ae7a-450c-808f-a336dda40668</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>451e04dc-b0a3-4f2f-a853-ce2636983352</PrimaryOrganizationID> <PrimaryTitle>sample string 10</PrimaryTitle> <PrimaryReportsTo>73973d2d-8c10-4854-a218-aa311fe4ac26</PrimaryReportsTo> <UserName>sample string 11</UserName> <Password>sample string 12</Password> <ParentID>d3a4eba7-54a8-4ffc-8481-3598d298e7dc</ParentID> <Deleted>false</Deleted> <DeletedByRef>false</DeletedByRef> <UserEmail>sample string 19</UserEmail> <HireDate>2022-06-05T00:43:08.4026089+00:00</HireDate> </Individual>
{ "ID": "0bc7aaf8-ae7a-450c-808f-a336dda40668", "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": "451e04dc-b0a3-4f2f-a853-ce2636983352", "PrimaryTitle": "sample string 10", "PrimaryReportsTo": "73973d2d-8c10-4854-a218-aa311fe4ac26", "UserName": "sample string 11", "Password": "sample string 12", "ParentID": "d3a4eba7-54a8-4ffc-8481-3598d298e7dc", "Deleted": false, "DeletedByRef": false, "UserEmail": "sample string 19", "HireDate": "2022-06-05T00:43:08.4026089+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>85e1c957-f9cd-44f5-af0b-70f3ca72f877</ID> <SiteID>bc09c5b3-5cc4-47d9-b079-95e894492aa4</SiteID> <IsAdmin>true</IsAdmin> <UserID>6b725322-e955-4cf0-99d7-12988c44d16b</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>7638e5ae-f45f-4973-b813-8bd8fac3b291</PrimaryOrganizationID> <PrimaryTitle>sample string 10</PrimaryTitle> <PrimaryReportsTo>c07154e7-a9d0-4a01-91b2-17af886dce02</PrimaryReportsTo> <UserName>sample string 11</UserName> <Password>sample string 12</Password> <ParentID>c29d5ee7-d7d5-4fa5-a306-d13b3ed23492</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>2022-06-05T00:43:08.4026089+00:00</Created> <CreatedBy>324de2d0-1983-4761-8698-ff4381c64f34</CreatedBy> <Updated>2022-06-05T00:43:08.4026089+00:00</Updated> <UpdatedBy>b6c757aa-38c8-432e-9f56-5bc91cbe10f9</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>2022-06-05T00:43:08.4026089Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>8cae6931-f37a-41b8-9b5c-f3510f5c2bde</LastCommentByID> <LastCommentBy>sample string 21</LastCommentBy> <CanRead>true</CanRead> <CanUpdate>true</CanUpdate> <CanDelete>true</CanDelete> <CanDelegate>true</CanDelegate> <SendEvalSurvey>true</SendEvalSurvey> <HireDate>2022-06-05T00:43:08.4026089+00:00</HireDate> </Individual>
{ "ID": "85e1c957-f9cd-44f5-af0b-70f3ca72f877", "SiteID": "bc09c5b3-5cc4-47d9-b079-95e894492aa4", "IsAdmin": true, "UserID": "6b725322-e955-4cf0-99d7-12988c44d16b", "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": "7638e5ae-f45f-4973-b813-8bd8fac3b291", "PrimaryTitle": "sample string 10", "PrimaryReportsTo": "c07154e7-a9d0-4a01-91b2-17af886dce02", "UserName": "sample string 11", "Password": "sample string 12", "ParentID": "c29d5ee7-d7d5-4fa5-a306-d13b3ed23492", "PrimaryOrganizationName": "sample string 13", "FullName": "sample string 14", "FormalName": "sample string 15", "FullOrderedName": "sample string 16", "Deleted": true, "DeletedByRef": true, "Created": "2022-06-05T00:43:08.4026089+00:00", "CreatedBy": "324de2d0-1983-4761-8698-ff4381c64f34", "Updated": "2022-06-05T00:43:08.4026089+00:00", "UpdatedBy": "b6c757aa-38c8-432e-9f56-5bc91cbe10f9", "IsGlobalAdmin": true, "UserEmail": "sample string 19", "LastComment": "sample string 20", "LastCommentDate": "2022-06-05T00:43:08.4026089+00:00", "LastCommentByID": "8cae6931-f37a-41b8-9b5c-f3510f5c2bde", "LastCommentBy": "sample string 21", "CanRead": true, "CanUpdate": true, "CanDelete": true, "CanDelegate": true, "SendEvalSurvey": true, "HireDate": "2022-06-05T00:43:08.4026089+00:00" }