Skip to main content

User

idUserId (string)

Possible values: Value must match regular expression ^((UR)|(URH))_[0-9a-zA-Z]{11,15}$

usernameUserString (string)

Possible values: <= 65536 characters

emailstring<email>

Email for the new user - must be a valid email (Can be the same as the username.)

firstNameUserString (string)

Possible values: <= 65536 characters

lastNameUserString (string)

Possible values: <= 65536 characters

userTypeUserType (string)

User type of the new user

User TypeUser IDUser ID
QTrial Life TimeUT_0Bf9UpqvyVC8NveUT_0Bf9UpqvyVC8Nve
QTrial StudentUT_0Bxw4uRTcOgipNjUT_0Bxw4uRTcOgipNj
QTrial - Other Academic 032016UT_0c70ofDcE2eJUGxUT_0c70ofDcE2eJUGx
QTrial Limit ExpiredUT_0fEDE6G1jDZdemxUT_0fEDE6G1jDZdemx
QTrialUT_0jRE9k0XtPcFimwUT_0jRE9k0XtPcFimw
Q Lite - 2nd YearUT_0kuHRSQccWrn6UBUT_0kuHRSQccWrn6UB
QTrial - Market Research 032016UT_0wF19s9EiVZipKZUT_0wF19s9EiVZipKZ
QTrial - Customer Experience 032016UT_1GMQPMpdE4RwwLPUT_1GMQPMpdE4RwwLP
QTrial Limited Time - AcademicUT_1MqAVjt7VAlju4dUT_1MqAVjt7VAlju4d
QTrial Limited Time - Govt/Non-ProfitUT_1zutw8mnzQiYKMtUT_1zutw8mnzQiYKMt
QTrial - Personal Use 032016UT_1ZzGXOZeDdDw4YZUT_1ZzGXOZeDdDw4YZ
QTrial Academic 082015UT_2065Ta4Dd7yRMOxUT_2065Ta4Dd7yRMOx
Q Lite 112015299UT_2bDphrj3daLhc5nUT_2bDphrj3daLhc5n
Vocalize UserUT_2c6FLGoehcbvqLzUT_2c6FLGoehcbvqLz
QTrial Limited Time - BusinessUT_2nQ9HtAQLoT8PA1UT_2nQ9HtAQLoT8PA1
Standard - QualtricsUT_3dBUKOs5wAT2mLWUT_3dBUKOs5wAT2mLW
Self-Enrolled UserUT_3gagqEwoURdNhDSUT_3gagqEwoURdNhDS
Q Lite ExpiredUT_3jThLjTvHe93oK9UT_3jThLjTvHe93oK9
QTrial - Undergraduate Student 032016UT_3lAQ89InP8TT6KNUT_3lAQ89InP8TT6KN
QTrial ExtendedUT_3Pi7u6w7m71rjDLUT_3Pi7u6w7m71rjDL
Single Project - PanelUT_3R6IAOTDfoIYFZaUT_3R6IAOTDfoIYFZa
Account ManagerUT_3VnyVSRBsrxYZ0xUT_3VnyVSRBsrxYZ0x
Panel Provider API UserUT_4JigLqMuSNKVgTbUT_4JigLqMuSNKVgTb
QTrial - Academic Staff 032016UT_4OrpK61mCahY4RfUT_4OrpK61mCahY4Rf
Standard - Qualtrics - no limitsUT_4SjjZmbPphZGKDqUT_4SjjZmbPphZGKDq
QTrial - Personal 0816UT_4T7p45oBAIvP3kVUT_4T7p45oBAIvP3kV
Mobile TrialUT_57sJJXiah9dzT5HUT_57sJJXiah9dzT5H
Project ExecutionUT_5AXhuWUAokDnUepUT_5AXhuWUAokDnUep
Tier 1 - JPUT_5d9QdndtTNeufWJUT_5d9QdndtTNeufWJ
QTrial CorporateUT_5dOLIfCc1NMQvkNUT_5dOLIfCc1NMQvkN
Full TrialUT_5hIxADmZZF1O2jyUT_5hIxADmZZF1O2jy
Standard - Qualtrics - wSurveyLimitsUT_5mBqn4vcJojrbr6UT_5mBqn4vcJojrbr6
GDRP_TestUserUT_5mRCBUSrd0grmyVUT_5mRCBUSrd0grmyV
QTrial Q LiteUT_5sPYKmhYjbKX5AxUT_5sPYKmhYjbKX5Ax
Vocalize User - no address bookUT_5zowKRstaEZpk0JUT_5zowKRstaEZpk0J
RC_ESSENTIALSUT_6G8RmaRu36xw1z7UT_6G8RmaRu36xw1z7
CoreXM StandardUT_6J7y4rMLOJP5hWJUT_6J7y4rMLOJP5hWJ
QTrial - K12 Employee 032016UT_6Kk7j8aGX8eOBrTUT_6Kk7j8aGX8eOBrT
Q Plus 082016599UT_6Ps7dYXIH65RevjUT_6Ps7dYXIH65Revj
Panel Provider API UserUT_6RsmRaeV8EjnrQpUT_6RsmRaeV8EjnrQp
Basecamp Training AccountUT_6tWFgC2KInx4fU9UT_6tWFgC2KInx4fU9
QTrial - Govt/Non-Profit 032016UT_6x6w54sU4d8O741UT_6x6w54sU4d8O741
QTrial Business 062015UT_7aCldam0G1WVLP7UT_7aCldam0G1WVLP7
QTrial Academic 062015UT_7UR7LPFYA2kK2nHUT_7UR7LPFYA2kK2nH
QTrial - Employee Insights 032016UT_86r7UWMwpnc8g9nUT_86r7UWMwpnc8g9n
Q Lite 082016299UT_8JndRCcxjQtafwVUT_8JndRCcxjQtafwV
Tier 2 - JPUT_8ktUHEukJl9DRjvUT_8ktUHEukJl9DRjv
QualtricsUT_8v0JhaZYRAMdHCsUT_8v0JhaZYRAMdHCs
QTrial - Academic 0816UT_9moS9VSTI5fuWrzUT_9moS9VSTI5fuWrz
Standard AccountUT_9od1enVtTulsEwAUT_9od1enVtTulsEwA
QTrial - Business 0816UT_9pGp9T03zlDqpjTUT_9pGp9T03zlDqpjT
RC_STARTERUT_9R1jHqLg7Ple5WRUT_9R1jHqLg7Ple5WR
Trial - Offline AppUT_9tuVaMn5VG9Cc4dUT_9tuVaMn5VG9Cc4d
QTrial PersonalUT_9uz7B0p3ExWT4MdUT_9uz7B0p3ExWT4Md
Q Lite 082015299UT_9YRcTbDa9KbfduBUT_9YRcTbDa9KbfduB
Basecamp Training AccountUT_aXX8fvcEi3K5eo5UT_aXX8fvcEi3K5eo5
Qtrial SharingUT_b43elxl37PDN3koUT_b43elxl37PDN3ko
QTrial Q Lite websummitUT_bl63ZyBjJD2SNGBUT_bl63ZyBjJD2SNGB
QTrial Personal 062015UT_bpIguMJMxRk491PUT_bpIguMJMxRk491P
Brand AdministratorUT_BRANDADMINUT_BRANDADMIN
QTrial - Other Business 032016UT_bwGJNWeDEJE0O9fUT_bwGJNWeDEJE0O9f
QTrial Default 102015UT_cAchjVb6asRttatUT_cAchjVb6asRttat
CoreXM UserUT_COREXMUSERUT_COREXMUSER
Tier 3 - JPUT_cupMPO78j4w9wRTUT_cupMPO78j4w9wRT
QTrial Limited Time - PersonalUT_cvUZSlh5MsgrG6NUT_cvUZSlh5MsgrG6N
CX AdministratorUT_CXADMINUT_CXADMIN
QTrial Business 082015UT_d7mOqTdAdfkGjUFUT_d7mOqTdAdfkGjUF
QTrial - EnterpriseUT_e3V2QVKA75FKKvbUT_e3V2QVKA75FKKvb
QTrial - Graduate Student 032016UT_eeQaVaSPNetAJsVUT_eeQaVaSPNetAJsV
Employee Insights AdminUT_EIADMINUT_EIADMIN
QTrial AcademicUT_eJQs8UTd28L5L25UT_eJQs8UTd28L5L25
QTrial - Govt/NonProfit 0816UT_emQQkDBTV7gXOrrUT_emQQkDBTV7gXOrr
QTrial Personal 082015UT_eS3OjrFu11kaZhPUT_eS3OjrFu11kaZhP
EX AdministratorUT_EXADMINUT_EXADMIN
UT_FREEACCOUNTUT_FREEACCOUNTUT_FREEACCOUNT
Free Trial AccountUT_FREETRIALACCOUNTUT_FREETRIALACCOUNT
Licensed UserUT_LICENSEDUSERUT_LICENSEDUSER
Multi-Brand AdministratorUT_MULTIBRANDADMINUT_MULTIBRANDADMIN
User Type With No PermissionsUT_NOPERMISSIONSUT_NOPERMISSIONS
ParticipantUT_PARTICIPANTUT_PARTICIPANT
Default Self-Enrollment TypeUT_SELFENROLLMENTUT_SELFENROLLMENT
Shared Survey UserUT_SHAREDUT_SHARED
360 AdministratorUT_THREESIXTYADMINUT_THREESIXTYADMIN

Possible values: Value must match regular expression ^UT_[0-9a-zA-Z]{5,15}$

organizationIdUserString (string)

Possible values: <= 65536 characters

divisionIdDivisionId (string)nullable

ID of the division that the user will be assigned

Possible values: Value must match regular expression ^(DV_[0-9a-zA-Z]{11,15}|)$

languageUserString (string)

Possible values: <= 65536 characters

accountStatus object
oneOf
UserAccountStatusEnum (string)

Possible values: [active, disabled, notVerified]

unsubscribedUnsubscribed (boolean)
accountCreationDatestring<date-time>nullable
accountExpirationDateUserDate (string)nullable

Possible values: Value must match regular expression ^[0-9]{4}-((0[0-9])|(1[0-2]))-(([0-2][0-9])|(3[0-1]))

passwordLastChangedDatestring<date-time>nullable
passwordExpirationDatestring<date-time>nullable
lastLoginDatestring<date-time>nullable
timeZoneUserTimeZone (string)nullable

The time zone setting for the new user.

Possible values: [Pacific/Midway, Pacific/Honolulu, America/Anchorage, America/Los_Angeles, America/Phoenix, America/Denver, Canada/East-Saskatchewan, America/Chicago, America/Rio_Branco, America/New_York, Canada/Atlantic, America/La_Paz, Canada/Newfoundland, America/Montevideo, America/Argentina/Buenos_Aires, America/Noronha, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/Reykjavik, Europe/London, Europe/Berlin, Africa/Bangui, Europe/Athens, Africa/Harare, Europe/Moscow, Africa/Nairobi, Asia/Tehran, Asia/Muscat, Asia/Baku, Asia/Kabul, Asia/Yekaterinburg, Asia/Karachi, Asia/Calcutta, Asia/Katmandu, Asia/Dhaka, Asia/Novosibirsk, Asia/Rangoon, Asia/Krasnoyarsk, Asia/Yakutsk, Asia/Seoul, Asia/Hong_Kong, Asia/Bangkok, Australia/Darwin, Australia/Adelaide, Australia/Brisbane, Australia/Canberra, Asia/Magadan, Pacific/Auckland, Pacific/Fiji, Pacific/Tongatapu]

responseCounts object

Learn More About Survey Response Counts

Review the Survey Response Counts document to learn more about the responseCounts object and its three properties: auditable, generated, and deleted.

auditableinteger<int32>nullablerequired

The cumulative count of all responses ever recorded and counted against the license, regardless of their current deletion status. This number:

  • Increases with each new response
  • Never decreases, even when responses are deleted
  • May include responses that are no longer accessible in the system
generatedinteger<int32>nullablerequired

The current count of active, non-auditable responses that are:

  • Accessible through the user interface
  • Not included in the auditable count
  • Subject to decrease if any of these responses are deleted
deletedinteger<int32>nullablerequired

A rolling count of responses removed from active use within the last 30 days. This number:

  • Increases when a response is deleted
  • Decreases 30 days after each deletion occurs
  • Does not include responses deleted more than 30 days ago, as these are permanently removed from the system and can no longer be recovered
permissions object

New permissions values. This is an additive patch of the permissions given. States can be [on, off, userType]

property name*any

New permissions values. This is an additive patch of the permissions given. States can be [on, off, userType]

identityProviderUserIdentityProvider (string)nullable

Possible values: Value must match regular expression ^[0-9a-zA-Z]{1,15}$

User
{
  "id": "string",
  "username": "string",
  "email": "user@example.com",
  "firstName": "string",
  "lastName": "string",
  "userType": "string",
  "organizationId": "string",
  "divisionId": "string",
  "language": "string",
  "accountStatus": "active",
  "unsubscribed": true,
  "accountCreationDate": "2024-07-29T15:51:28.071Z",
  "accountExpirationDate": "string",
  "passwordLastChangedDate": "2024-07-29T15:51:28.071Z",
  "passwordExpirationDate": "2024-07-29T15:51:28.071Z",
  "lastLoginDate": "2024-07-29T15:51:28.071Z",
  "timeZone": "Pacific/Midway",
  "responseCounts": {
    "auditable": 0,
    "generated": 0,
    "deleted": 0
  },
  "permissions": {},
  "identityProvider": "string"
}