# Update a Data Request

Update details of a Data Request


Endpoint: POST /v3/datarequests/update
Version: 3.0
Security: Bearer

## Header parameters:

  - `version` (number)
    Version number of the MeasureOne API you wish to integrate.

  - `Authorization` (string)
    Authorization API Key

  - `Content-type` (string)
    Content-type of the request payload. MeasureOne accepts content in application/json format unless specified otherwise

## Request fields (application/json):

  - `id` (string, required)
    Unique ID of the Data Request identified by MeasureOne

  - `request_details` (object)
    Details of the data request that you can provide while creation. This helps in driving the the workflow and the end user experience on MeasureOne Link.

  - `request_details.student_type` (string)
    Type of the student.
    Enum: "CURRENT_STUDENT", "ALUMNI"

  - `request_details.employment_status` (string)
    Pre-identified employment status .
    Enum: "CURRENT", "FORMER"

  - `request_details.employment_type` (string)
    Type of the Employee.
    Enum: "EMPLOYEE", "GIG_WORKER", "CONTRACTOR"

  - `request_details.tax_year` (number)
    An annual accounting year for tax calculation. e.g 2022.
    Example: 1994

  - `request_details.earnings_period_type` (string)
    Earnings period type. If none specified then customer default preference will be used.
    Enum: "CURRENT", "HISTORIC"

  - `request_details.get_yearly_earnings` (boolean)
    Include yearly earnings CY + last 2 years in the VOIE/Income Summary report. If none specified then customer default preference will be used.

  - `request_details.enable_bank_income` (boolean)
    Whether to enable bank account connect option for the Data Request. If none specified then customer default preference will be used.

  - `request_details.use_legacy_insurance` (boolean)
    Flag to support legacy INSURANCE_POLICY source_data_type.

  - `request_details.institution_type` (array)
    Datasource categories for which you want to filter in M1Link.

: To search for academic institutions
: To search for employers
: To search for payroll providers
: To search for home insurance providers
: To search for auto insurance providers
: To search for brokerage firms
: To search for Banks

  - `request_details.datasource` (object)
    Pre-identified Datasource details for the Individual to connect. Either the  or the  should be provided. If both are provided, the  will be ignored.

  - `request_details.datasource.id` (string)
    Unique ID of the datasource identified by MeasureOne. When provided, the Individual will be directly prompted to provide their credentials for this Datasource.

  - `request_details.datasource.display_name` (string)
    Name of the datasource for which you want the Individual to connect their account. The Individual will be guided to connect to the provided name.

  - `request_details.countries` (array)
    Pre-identified country code. Providing a value will allow user to search the datasources only from selected country.
    Enum: "US", "CA"

  - `request_details.enable_manual_upload` (boolean)
    Whether to enable manual upload of document for the Data Request. If none specified then customer default preference will be used.

  - `request_details.enable_datasource_override` (boolean)
    Override widget deeplink flow. If none specified then customer default preference will be used. `This attribute is deprecated. Refer to datasource.enable_override in the parent object

  - `request_details.show_connect_method_options` (boolean)
    When multiple connect options such as direct connection, manual upload, bank account connection are enabled for datarequest then user can be presented with all the options upfront in the widget. If none specified then customer default preference will be used.

  - `enable_direct_connection` (boolean)
    Whether to enable direct connection for the Data Request. If none specified then customer default preference will be used.

  - `show_connect_method_options` (boolean)
    When multiple connect options such as direct connection, manual upload, bank account connection are enabled for datarequest then user can be presented with all the options upfront in the widget. If none specified then customer default preference will be used.

  - `third_party_requester` (string)
    Name of the third party requester. This name will be reflected in the communications to the Individual.

  - `requester_name` (string)
    Display name of the requester.  This name will be reflected in the communications to the Individual. If not provided, the system will take your application display name set in your account preferences.

  - `requester_logo_uri` (string)
    URI for the logo to be displayed for the widget. If not provided it will be taken from the account preferences

  - `processing_config` (object)
    Processing configuration for this request.

  - `processing_config.max_latency` (integer)
    The maximum allowable processing time (in seconds) to complete the request. The processing timer starts at the time the datasource connection is established or in the case of manual upload after all request documents have been submitted. A value of  (default) means no maximum allowable processing time. 

If the processing time exceeds the max_latency, the request will be terminated and a session.terminated webhook will be triggered. Subscribe to the session.terminated to receive the webhook.

  - `delivery_details` (array)
    List of endpoints to which the [webhooks](#tag/webhooks) should be delivered

  - `delivery_details.event_type` (string, required)
    Event for which you want a notification. If not provided, it will be taken from the default account preference. Refer to Webhooks section to see the list of all events supported
    Enum: "datarequest.items_available", "datarequest.items_processed", "datarequest.no_items", "datarequest.report_available", "datarequest.report_error", "datarequest.acquisition_completed", "datarequest.updates_available", "datarequest.refresh_failed", "datasource.connected", "transaction.processed", "unprocessable.entity", "session.rejected", "session.terminated", "session.no_login", "item.created", "item.processed", "item.unavailable"

  - `delivery_details.url` (string, required)
    URL to which the webhook should be delivered

  - `delivery_details.headers` (object)
    Additional http headers that you may want to pass. MeasureOne will send the data with content-type as
    Example: {"content-type":"application/json"}

  - `delivery_details.x_auth_token_credentials` (object)
    MeasureOne will generate the authorization token with provided auth token credentials and use the generated token while delivering webhooks.  details can be provided when a fresh authorization token needs to be used when MeasureOne delivers webhook.

  - `delivery_details.x_auth_token_credentials.token_type` (string, required)
    Type of token
    Enum: "JWT"

  - `delivery_details.x_auth_token_credentials.http_method` (string, required)
    Type of HTTP method
    Enum: "POST"

  - `delivery_details.x_auth_token_credentials.url` (string, required)
    Endpoint url to generate auth token

  - `delivery_details.x_auth_token_credentials.key_id` (string)
    Unique ID of the Encryption key identified by MeasureOne.  holds credentials details. So,  header and  can be provided in encrypted form. When  is provided then  header and attributes value in  object will be treated as encrypted. Please reach out to us on support@mesureone.com to get your encryption key_id setup.

  - `delivery_details.x_auth_token_credentials.headers` (object)
    Request body headers that you may want to pass while calling endpoint.

MeasureOne supports two content-type  and  for generate auth token endpoint. An unspecified content-type will default to

  - `delivery_details.x_auth_token_credentials.data` (object)
    Data that we need to pass in body while calling endpoint. attribute's value can be pass in encrypted form when  is provided.

  - `delivery_details.x_auth_token_credentials.response_token_path` (string)
    Path from response for token attribute. When  is unspecified then complete response will be used as auth token.

  - `refresh_policy` (object)
    Refresh Policy details to auto refresh data periodically

  - `refresh_policy.enabled` (boolean)
    Indicates whether auto-refresh is enabled for the Data Request. Set to  if wants to use auto-refresh for the Data Request. If  is provided then  should be .

  - `refresh_policy.schedule` (any)

  - `refresh_policy.effective_date` (number)
    Timestamp (milliseconds) when the refresh should start

  - `refresh_policy.end_date` (number)
    Timestamp (milliseconds) when the refresh should end

## Response 200 fields (application/json):

  - `id` (string)
    MeasureOne recognized Unique ID of the Data request
    Example: "dr_1faOM8Q4efEWIjzdE2SBM2kLq4O"

## Response 400 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 401 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 404 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error

## Response 405 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds
    Example: 1655227025839

  - `error_code` (string)
    MeasureOne Error code
    Example: "METHOD_NOT_ALLOWED"

  - `error_message` (string)
    Details of the error
    Example: "Given Method not allowed"

## Response 500 fields (application/json):

  - `timestamp` (number)
    Timestamp in milliseconds

  - `error_code` (string)
    MeasureOne Error code

  - `error_message` (string)
    Details of the error