POST individuals?tz={tz}

Request Information

URI Parameters

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

Name	Description
tz `string` Optional parameter to set time zone information.	`string` Optional parameter to set time zone information.

Body Parameters (Individual)

This object takes all the parameters needed to create a new individual.

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

Request Formats

application/xml, text/xml

Sample

<Individual xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>eb41797a-4249-401b-a7bc-74e754efe00e</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>08a407f9-5111-4851-adca-dea03f9c4659</PrimaryOrganizationID>
  <PrimaryTitle>sample string 10</PrimaryTitle>
  <PrimaryReportsTo>b7a761bc-8b62-4f66-8e8b-4e7e74143c07</PrimaryReportsTo>
  <UserName>sample string 11</UserName>
  <Password>sample string 12</Password>
  <ParentID>fbd18859-425d-4ec7-9ba9-0a779880a907</ParentID>
  <Deleted>false</Deleted>
  <DeletedByRef>false</DeletedByRef>
  <UserEmail>sample string 19</UserEmail>
  <HireDate>2024-10-24T07:45:21.221125+00:00</HireDate>
</Individual>

application/json, text/json

Sample

{
  "ID": "eb41797a-4249-401b-a7bc-74e754efe00e",
  "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": "08a407f9-5111-4851-adca-dea03f9c4659",
  "PrimaryTitle": "sample string 10",
  "PrimaryReportsTo": "b7a761bc-8b62-4f66-8e8b-4e7e74143c07",
  "UserName": "sample string 11",
  "Password": "sample string 12",
  "ParentID": "fbd18859-425d-4ec7-9ba9-0a779880a907",
  "Deleted": false,
  "DeletedByRef": false,
  "UserEmail": "sample string 19",
  "HireDate": "2024-10-24T07:45:21.221125+00:00"
}

Response Information

Resource Description (Individual)

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

Response Formats

application/xml, text/xml

Sample

<Individual xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>f634e6dc-4146-459a-a6b4-33912ed02a64</ID>
  <SiteID>d97bff61-d925-460d-866a-07fa129f2096</SiteID>
  <IsAdmin>true</IsAdmin>
  <UserID>f4f7af4a-5991-46ac-a41d-cf72bd930207</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>7adb260d-8b8a-4e7e-be02-a919ea8a6edd</PrimaryOrganizationID>
  <PrimaryTitle>sample string 10</PrimaryTitle>
  <PrimaryReportsTo>be02c35c-258b-4587-a567-6649000dd737</PrimaryReportsTo>
  <UserName>sample string 11</UserName>
  <Password>sample string 12</Password>
  <ParentID>3e9166c5-9c14-4927-a481-9cf61786b45a</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>2024-10-24T07:45:21.221125+00:00</Created>
  <CreatedBy>c58f4c7b-ba68-483f-9855-b4155f02c824</CreatedBy>
  <Updated>2024-10-24T07:45:21.221125+00:00</Updated>
  <UpdatedBy>17575998-5636-4165-b054-2c8d6e8cfb5e</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>2024-10-24T07:45:21.221125Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>f84f2038-d183-436a-8a0f-e100cd914ff9</LastCommentByID>
  <LastCommentBy>sample string 21</LastCommentBy>
  <CanRead>true</CanRead>
  <CanUpdate>true</CanUpdate>
  <CanDelete>true</CanDelete>
  <CanDelegate>true</CanDelegate>
  <SendEvalSurvey>true</SendEvalSurvey>
  <HireDate>2024-10-24T07:45:21.221125+00:00</HireDate>
</Individual>

application/json, text/json

Sample

{
  "ID": "f634e6dc-4146-459a-a6b4-33912ed02a64",
  "SiteID": "d97bff61-d925-460d-866a-07fa129f2096",
  "IsAdmin": true,
  "UserID": "f4f7af4a-5991-46ac-a41d-cf72bd930207",
  "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": "7adb260d-8b8a-4e7e-be02-a919ea8a6edd",
  "PrimaryTitle": "sample string 10",
  "PrimaryReportsTo": "be02c35c-258b-4587-a567-6649000dd737",
  "UserName": "sample string 11",
  "Password": "sample string 12",
  "ParentID": "3e9166c5-9c14-4927-a481-9cf61786b45a",
  "PrimaryOrganizationName": "sample string 13",
  "FullName": "sample string 14",
  "FormalName": "sample string 15",
  "FullOrderedName": "sample string 16",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2024-10-24T07:45:21.221125+00:00",
  "CreatedBy": "c58f4c7b-ba68-483f-9855-b4155f02c824",
  "Updated": "2024-10-24T07:45:21.221125+00:00",
  "UpdatedBy": "17575998-5636-4165-b054-2c8d6e8cfb5e",
  "IsGlobalAdmin": true,
  "UserEmail": "sample string 19",
  "LastComment": "sample string 20",
  "LastCommentDate": "2024-10-24T07:45:21.221125+00:00",
  "LastCommentByID": "f84f2038-d183-436a-8a0f-e100cd914ff9",
  "LastCommentBy": "sample string 21",
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "SendEvalSurvey": true,
  "HireDate": "2024-10-24T07:45:21.221125+00:00"
}

Name	Description
ID `globally unique identifier` Required on Update ID of the given individual.	`globally unique identifier` Required on Update ID of the given individual.
SiteID `globally unique identifier` ReadOnly ID of the site for the given individual.	`globally unique identifier` ReadOnly ID of the site for the given individual.
IsAdmin `boolean` Administrator setting for the given individual.	`boolean` Administrator setting for the given individual.
UserID `globally unique identifier` ReadOnly User ID of the given individual.	`globally unique identifier` ReadOnly User ID of the given individual.
Prefix `string` Prefix of the given individual's name. (Max length 25 characters)	`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)	`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)	`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)	`string` Required Last name of the given individual. (Max length 50 characters)
UserDefined1 `string` User defined field one. (Max length 255 characters)	`string` User defined field one. (Max length 255 characters)
UserDefined2 `string` User defined field two. (Max length 255 characters)	`string` User defined field two. (Max length 255 characters)
UserDefined3 `string` User defined field three. (Max length 255 characters)	`string` User defined field three. (Max length 255 characters)
UserDefined4 `string` User defined field four. (Max length 255 characters)	`string` User defined field four. (Max length 255 characters)
Email `string` Required on Create Email address of the given individual. (Max length 255 characters)	`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.	`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)	`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.	`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)	`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.)	`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.	`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.	`string` ReadOnly Name of the primary organization for the given individual.
FullName `string` ReadOnly Full name of the given individual.	`string` ReadOnly Full name of the given individual.
FormalName `string` ReadOnly Formal name of the given individual.	`string` ReadOnly Formal name of the given individual.
FullOrderedName `string` ReadOnly Full ordered name of the given individual.	`string` ReadOnly Full ordered name of the given individual.
Deleted `boolean` ReadOnly Deleted status of the given individual.	`boolean` ReadOnly Deleted status of the given individual.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the given individual.	`boolean` ReadOnly Deleted by reference status of the given individual.
Created `date` ReadOnly Date the given individual was created.	`date` ReadOnly Date the given individual was created.
CreatedBy `globally unique identifier` ReadOnly ID of the person that created the given individual.	`globally unique identifier` ReadOnly ID of the person that created the given individual.
Updated `date` ReadOnly Date the given individual was last 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.	`globally unique identifier` ReadOnly ID of the person that last updated the given individual.
IsGlobalAdmin `boolean` ReadOnly Global administrator setting for the given individual.	`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.)	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`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.	`boolean` ReadOnly Delegate security setting for the individual based on the current logged in user.
SendEvalSurvey `boolean` ReadOnly Send Individual Evaluation Surveys	`boolean` ReadOnly Send Individual Evaluation Surveys
HireDate `date` Date the given Individual was hired.	`date` Date the given Individual was hired.