General API Info
Supported Methods
Arms
Data Access Groups
Events
Field Names
Files
File Repository
Instruments
Logging
Metadata
Projects
Records
Repeating Instruments and Events
Reports
REDCap
Surveys
Users & User Privileges
User Roles
REDCap API Documentation
Method Name
Import Project Information
Description
This method allows you to update some of the basic attributes of a given REDCap project, such as the project's title, if it is longitudinal, if surveys are enabled, etc. Its data format corresponds to the format in the API method Export Project Information.
URL
Supported Request Method
Permissions Required
To use this method, you must have API Import/Update privileges *and* Project Setup/Design privileges in the project.
Parameters (case sensitive)
Required
Returnstoken
The API token specific to your REDCap project and username (each token is unique to each user for each project). See the section on the left-hand menu for obtaining a token for a given project.
The API token specific to your REDCap project and username (each token is unique to each user for each project). See the section on the left-hand menu for obtaining a token for a given project.
content
project_settings
project_settings
format
csv, json, xml
csv, json, xml
data
Contains some or all of the attributes from Export Project Information in the same data format as in the export. These attributes will change the project information.
Contains some or all of the attributes from Export Project Information in the same data format as in the export. These attributes will change the project information.
Attributes for the project in the format specified. For any values that are boolean, they should be represented as either a '0' (no/false) or '1' (yes/true). The following project attributes can be udpated:
project_title, project_language, purpose, purpose_other, project_notes, custom_record_label, secondary_unique_field, is_longitudinal, surveys_enabled, scheduling_enabled, record_autonumbering_enabled, randomization_enabled, project_irb_number, project_grant_number, project_pi_firstname, project_pi_lastname, display_today_now_button, bypass_branching_erase_field_prompt
Returns the number of values accepted to be updated in the project settings (including values which remained the same before and after the import).