PUSH User object

deprecated Represents a user.

Fields

Field Type Description
id
required		 String The unique ID of the user
type
required		 String This is always USER
name
optional		 String The name of the user
personoptional PUSH Person object Reference to the person record.
avataroptional PUSH Media object An optional avatar image.
localeoptional String The locale code
createdoptional Date/time The creation date of the user account.
timeZoneoptional String The user's time zone.
emailAddressoptional String The user's email address.
domicileoptional String An optional country code.
organizationoptional PUSH Organization object The organization
managingOrganizationoptional PUSH Organization object The managing organization
creatoroptional PUSH ClientApp The application that created this user
thirdPartyIdsoptional List of PUSH ThirdPartyId objects An optional list of third party IDs

Example

{
  "id": "CkGyUQ2b5mNHxyCqkzflKg",
  "name": "John Smith",
  "emailAddress": "john@drillster.com",
  "thirdPartyIds": [{
    "thirdParty": "ABC",
    "id": "123dzenab"
  }]
}

 

Last updated on