Sign in

v11

latestOpenAPI 3.1.0Proprietary2026-07-126616.7 KB
User

Update user by key

Updates a specific user by their key

post/users/{userKey}

Path parameters

userKeystring required

User key

Request body

externalSharingRestrictionOnTeamsPipelinesboolean nullable
securityReportOnTeamsPipelinesboolean nullable
automaticallySendInvoiceEmailsboolean nullable
emailsToSendInvoiceTostring[] nullable
customerSpecifiedInvoiceDatastring nullable
lastTrialStartinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

lastProPlusTrialStartinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

tourIdstring nullable
firstExtensionstring nullable
hasCancellationDiscountboolean nullable

Example request

{
  "lastTrialStart": 1646870400000,
  "lastProPlusTrialStart": 1646870400000
}

Response

Successfully updated user

userIdinteger nullable
emailstring nullable
orgKeystring nullable
creationTimestampinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

lastUpdatedTimestampinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

lastSavedTimestampinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

lastSeenTimestampinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

googleProfileIdstring nullable
googleDriveIdstring nullable
googleProfilePhotoUrlstring nullable
googleProfileLinkstring nullable
googleProfileFullNamestring nullable
googleProfileFirstNamestring nullable
googleProfileLastNamestring nullable
googleProfileGenderstring nullable
googleProfileLocalestring nullable
googleAnalyticsClientIdstring nullable
timezoneIdstring nullable
userSource'UNKNOWN' | 'WEB' | 'MOBILE' | 'SHARING' | 'GOOGLE_APPS_MARKETPLACE' | 'ANDROID' | 'GMAIL_ADDON' | 'WEB_MAIL_MERGE' | 'WEB_STREAK_SHARE' | 'WEB_EMAIL_TRACKING'
userType'HUMAN' | 'AGENT'
firstExtensionstring nullable
hasCancellationDiscountboolean nullable
securityReportOnTeamsPipelinesboolean nullable
externalSharingRestrictionOnTeamsPipelinesboolean nullable
automaticallySendInvoiceEmailsboolean nullable
emailsToSendInvoiceTostring[] nullable
customerSpecifiedInvoiceDatastring nullable
phoneNumberstring nullable
isOauthCompleteboolean
firstOauthTimestampinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

tourIdstring nullable
userSettingsKeystring nullable
streakCalendarIdstring nullable
lastTrialStartinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

lastTrialLengthinteger
lastProPlusTrialStartinteger nullable

Epoch timestamp in milliseconds since 1970-01-01T00:00:00Z.

onTrialWithoutCreditCardboolean nullable
canceledTrialboolean nullable
wantsTaskDigestEmailboolean nullable
archiveKeysetFileLinkstring nullable
userKeystring nullable
displayNamestring nullable
keystring nullable
intercomHmacstring nullable
intercomJwtstring nullable
experimentsobject nullable
integrationSegmentinteger nullable

Example response

{
  "creationTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000,
  "lastSavedTimestamp": 1646870400000,
  "lastSeenTimestamp": 1646870400000,
  "usedPlatforms": [
    {
      "firstDateOfUse": 1646870400000,
      "lastDateOfUse": 1646870400000
    }
  ],
  "firstOauthTimestamp": 1646870400000,
  "lastTrialStart": 1646870400000,
  "lastProPlusTrialStart": 1646870400000
}