Qualtrics
Home
Guides
API Reference
{{user.name}}
Log In
Qualtrics API and SDK Reference, Guides, Documentation, Use Cases, and Tutorials
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
v3
v3
stable
Home
Guides
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Scenario Guides
API General Instructions
Overview
Base URL and Datacenter IDs
Finding your Qualtrics IDs
API Key Authentication
OAuth Authentication (Client Credentials)
Using OAuth (Auth Code)
Parameters
Responses
Other APIs
Migration Guide V2 to V3
Beta to V3 Migration Guide
Time Zones
Dates and Times
Language Codes
Pagination
Limits
Common Tasks
Using the API Code Samples
Managing Surveys
Managing Users
Managing User Groups
Getting Survey Responses via the New Export APIs
Getting Information about Distributions
Working with Surveys using the Conversational APIs
Managing Right to Erasure
Survey Response Import Guide
Building Surveys
New Survey Response Export Guide
Common Use Case Examples
Working with Survey Sessions
Send Survey as SMS Message or Email
Code to send SMS or eMail
Generate Custom Distribution Links
Retrieve Survey Responses in Real Time
XM Directory
Managing Contacts in Mailing Lists for XM Directory
How to Load Contact Transactions and Distribute Survey
Managing Mailing Lists for XM Directory
Managing Directory Contacts for XM Directory
Using Transactions in XM Directory
Using Contact Transactions in XM Directory
Using Transaction Batches in XM Directory
Importing Mailing Lists with Transactions
Research Core to XM Directory Migration Guide
SDKs
Mobile iOS Intercept SDK
Getting Started with the Mobile App SDK on iOS
App Feedback iOS API Reference
iOS Mobile App SDK Releases
Troubleshooting
User Analytics with the Mobile App SDK
Mobile Android Intercept SDK
Getting Started with Mobile App SDK on Android
App Feedback Android API Reference
Android Mobile App SDK Releases
Troubleshooting
User Analytics with the Mobile App SDK
Mobile React Native SDK
App Feedback React Native API Reference
React Native App SDK Releases
User Analytics with the Mobile App SDK
Actions and Webhooks
Inbound Events
Actions
Webhooks
Support
Organizations
get
Get Organization
Divisions
post
Create Division
get
Get Division
put
Update Division
Groups
get
List Groups
post
Create Group
get
Get Group
put
Update Group
delete
Delete Group
post
Add User to Group
delete
Remove User from Group
Users
get
List Users
get
Get User
post
Create User
put
Update User
delete
Delete User
get
Get User API Token
post
Create User API Token
get
Who Am I
Survey Definitions
Questions
get
Get Question
get
List Questions
post
Create Question
put
Update Question
delete
Delete Question
Flows
put
Update Flow
get
Get Flow
put
Update Flow Element
Blocks
get
Get Block
put
Update Block
delete
Delete Block
post
Create Block
Options
get
Get Options
put
Update Options
Survey
get
Get Survey
get
Get Survey Metadata
delete
Delete Survey
post
Create Survey
Languages
get
Get Survey Languages
get
Get Survey Translations
put
Update Survey Languages
put
Update Survey Translations
Versions
post
Create Survey Version
get
List Survey Versions
get
Get Survey Version
Legacy Surveys APIs
Survey CRUD Operations
get
Get Survey
put
Update Survey
delete
Delete Survey
get
List Survey
Import
post
Import Survey From URL
post
Import Survey
post
Copy Survey
post
Share Survey
post
Insert Embedded Data Fields
get
Get Survey Quotas
Survey Sessions
post
Create Session
post
Update Session
get
Get Session
delete
Delete Session
post
Close Session
Survey Response Exports
post
Create Response Export
get
Get Response Export Progress
get
Get Response Export File
get
List Survey Filters
Survey Response Imports
post
Start Response Import
post
Start Response Import By URL
get
Get Response Import Progress
Legacy Response Exports
post
Legacy Create Response Export
get
Legacy Get Response Export Progress
get
Legacy Get Response Export File
Survey Responses
Responses
post
Create a New Response
get
Retrieve a Survey Response
delete
Delete a Survey Response
Survey Response Management
put
Update Response
Legacy Response Imports
post
Import Responses (Deprecated)
post
Import Responses From URL (Deprecated)
get
Get Response Import Progress (Deprecated)
Libraries
get
List Libraries
get
List Library Blocks
get
List Library Questions
get
List Library Surveys
Message Library
get
List Library Messages
get
Get Library Message
post
Create Library Message
put
Update Library Message
delete
Delete Library Message
Graphic Library
post
Upload Graphic
post
Upload Graphic From URL
delete
Delete Graphic
Research Core Contacts
get
Get Mailing List
get
List Mailing Lists
post
Create Mailing List
put
Update Mailing List
delete
Delete Mailing List
get
List Contacts
get
Get Contact
post
Create Contact
put
Update Contact
delete
Delete Contact
post
Create Contacts Import
post
Create Contacts Import From URL
get
Get Contacts Import Progress
get
Get Contacts Import Progress Summary
get
List Samples
get
Get Sample
Event Subscriptions
get
List Subscriptions
get
Get Subscription
post
Create Subscription
XM Directory API
Mailing Lists
get
Get contacts in a mailing list who have had an email bounce.
get
Get contacts in a mailing list who have opted out
Directories
get
List directories for a brand
/directories/{directoryId}/contacts/optedOutContacts
get
Get contacts in a directory who have opted out
XM Directory Contacts
get
List Directory Contacts
get
Get Directory Contact
get
Get Contact History
post
Create Directory Contact
put
Update Directory Contact
delete
Delete Directory Contact
post
Search Contacts
XM Directory Mailing Lists
get
List Mailing Lists
get
Get Mailing List
post
Create Mailing List
put
Update Mailing List
delete
Delete XM Directory Mailing List
XM Directory Contacts in Mailing Lists
get
List Contacts In Mailing List
get
Get Contact In Mailing List
get
Get Contact History In Mailing List
post
Create Contact In Mailing List
put
Update Contact in Mailing List
delete
Delete Contact in Mailing List
XM Directory Samples
get
List Samples
get
Get Sample
post
Perform Sample on MailingList/Batch
put
Update Sample
delete
Delete Sample
get
Get Sample Contacts
get
Get Create Sample Progress
XM Directory Sample Definitions
get
List Sample Definitions
get
Get Sample Definition
post
Create Sample Definition
put
Update Sample Definition
delete
Delete Sample Definition
XM Directory Contact Transactions
get
List Contact Transactions
get
Get Contact Transaction
post
Create Contact Transactions
post
Append Contact Transaction
put
Update Contact Transaction
delete
Delete Contact Transaction
XM Directory Transaction Batches
get
Get Transaction Batches in a Directory
get
Get Transactions in a Batch
get
Get Transaction Batch
post
Create Transaction Batch
delete
Delete Transaction Batch
post
Add Transactions to a Batch
delete
Remove Transaction from a Batch
XM Directory Distributions
Distributions
post
Create Distribution and Distribution Links
get
List Distributions
get
Get Distribution
delete
Delete Distribution
post
Create Reminder Distribution
post
Create Thank You Distribution
SMS Distributions
post
Create SMS Survey Distribution
get
Get SMS Distribution
delete
Delete SMS Distribution
get
List SMS Distributions
WhatsApp Distributions
post
Create WhatsApp Distribution
get
Get WhatsApp Distribution
delete
Delete WhatsApp Distribution
get
List WhatsApp Distributions
Transaction Batches
post
Generate Transaction Batch Distribution Links
post
Transaction Batch Distribution Create
get
Distribution Links
post
Email Mailing List
XM Directory Imports
post
Import Contacts into Mailing List with Transactions
get
Transaction Contacts Import Status
get
Transaction Contacts Import Summary
Tickets
get
Get Tickets
XM Directory Custom Contact Frequency
post
Create Contact-Frequency Rule
get
List Contact-Frequency Rules
get
Get Frequency Rule
put
Update Contact-Frequency Rule
delete
Delete Contact-Frequency Rule
Logging Events
get
Get Activity Types
get
Get Activity Log
Data Privacy
post
Create Erasure Request
get
List Erasure Requests
get
Get Erasure Request
Scenario Guides
API General Instructions
Common Tasks
Common Use Case Examples
View All 4
SDKs
Mobile iOS Intercept SDK
Mobile Android Intercept SDK
Mobile React Native SDK
Actions and Webhooks
Inbound Events
Actions
Webhooks
API Reference
Surveys
Update Survey Control Elements
Survey Taking
Bulk Export Survey Responses
Single Response Export
Importing Survey Responses
Manage Users
Manage Groups
XM Directory Contacts
XM Directory Mailing Lists
XM Directory Samples
XM Directory Contact Transactions
XM Directory Transaction Batches
XM Directory Contact Frequency
Tickets
Activity Logs
Data Privacy