STstreakyc
Users

Update user by key

Changed on

Updates a specific user by their key

post/v1/users/{userKey}

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v1/users/{userKey}
  • Auth
    HTTP bearer

Path parameters

userKeystring required

Request body

timezoneIdstring nullable

IANA timezone identifier for the user, such as America/Los_Angeles.

firstNamestring nullable

Given name for the user.

lastNamestring nullable

Family name for the user.

automaticallySendInvoiceEmailsboolean nullable

Whether invoice emails should be sent automatically.

emailsToSendInvoiceTostring[] nullable

Who should receive invoices

customerSpecifiedInvoiceDatastring nullable

Custom data that should be shown on the invoice

Response

OK

emailstring required

The user's normalized email address.

creationTimestampinteger required

Timestamp when the user account was created, in epoch milliseconds.

lastUpdatedTimestampinteger required

Timestamp when the user entity was last updated, in epoch milliseconds.

lastSavedTimestampinteger required

Timestamp when the user entity was last persisted, in epoch milliseconds.

lastSeenTimestampinteger nullable

Timestamp when Streak last saw activity for the user, in epoch milliseconds.

googleProfileIdstring nullable

Stable Google profile identifier associated with the user's OAuth account.

googleProfilePhotoUrlstring nullable

URL of the user's Google profile photo, when available.

googleProfileLinkstring nullable

URL of the user's Google profile, when available.

googleProfileFullNamestring nullable

Full display name from the user's Google profile.

googleProfileFirstNamestring nullable

Given name from the user's Google profile, when available.

googleProfileLastNamestring nullable

Family name from the user's Google profile, when available.

timezoneIdstring nullable

IANA timezone identifier for the user, such as America/Los_Angeles.

userType'HUMAN' | 'AGENT' required
securityReportOnTeamsPipelinesboolean

Whether security report emails are enabled for the user's team pipelines.

externalSharingRestrictionOnTeamsPipelinesboolean

Whether external sharing is restricted on the user's team pipelines.

automaticallySendInvoiceEmailsboolean

Whether invoice emails should be sent automatically for the user's billing context.

emailsToSendInvoiceTostring[] nullable

Additional email addresses that should receive invoice emails.

customerSpecifiedInvoiceDatastring nullable

Customer-provided invoice data to include with billing records.

firstOauthTimestampinteger nullable

Timestamp when the user first completed OAuth, in epoch milliseconds.

wantsTaskDigestEmailboolean

Whether the user wants to receive task digest emails.

displayNamestring required

Display name Streak uses for the user in UI surfaces.

keystring required

Key for this user.

Example response

{
  "creationTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000,
  "lastSavedTimestamp": 1646870400000,
  "lastSeenTimestamp": 1646870400000,
  "firstOauthTimestamp": 1646870400000
}

Changes