Update Data Request

Update the metadata or authentication details of a pending Data Request.

(Please note that you cannot update a Data Request that has already been viewed or completed.)

See the Data Requests documentation for more information.

HTTP Request

PUT https://api.docspring.com/api/v1/data_requests/<DATA_REQUEST_ID>

Authentication

You must send an Authorization header with the value Basic followed by base 64 encoded token_id:token_secret.

For example: Authorization: Basic dG9rZW5faWQ6dG9rZW5fc2VjcmV0Cg==

See the Authentication documentation for more information.

Example Response

{
  "status": "success",
  "data_request": {
    "id": "drq_000000000000000001",
    "email": "[email protected]",
    "name": "John Doe",
    "order": 1,
    "fields": ["last_name"],
    "metadata": {
      "user_id": 42
    },
    "state": "complete",
    "viewed_at": "2018-10-23T13:00:00Z",
    "completed_at": "2018-10-23T13:05:00Z"
  }
}

Example Code

var DocSpring = require('docspring')

client = new DocSpring.Client(config)

client.updateDataRequest(
  'drq_000000000000000001',
  {
    auth_type: 'oauth',
    auth_provider: 'google',
    auth_session_started_at: '2018-10-23T13:00:00Z',
  },
  function (error, dataRequest) {
    if (error) throw error
    console.log(dataRequest)
  }
)

require 'docspring'

docspring = DocSpring::Client.new

response = docspring.update_data_request(
  'drq_000000000000000001',
  auth_type: 'oauth',
  auth_provider: 'google',
  auth_session_started_at: '2018-10-23T13:00:00Z'
)
puts response

import docspring

client = docspring.Client()
response = client.update_data_request(
  "drq_000000000000000001",
  {
    "auth_type": 'oauth',
    "auth_provider": 'google',
    "auth_session_started_at": '2018-10-23T13:00:00Z'
  }
)
print(response)

<?php
$docspring = new DocSpring\Client();
$data_request_id = 'drq_000000000000000001';
$data = new DocSpring\Model\UpdateSubmissionDataRequestData();
$data->setAuthType('oauth');
$data->setAuthProvider('google');
$data->setAuthSessionStartedAt('2018-10-23T13:00:00Z');
$response = $docspring->updateDataRequest($data_request_id, $data);
echo $response;

using System;
using System.Diagnostics;
using DocSpring.Client.Api;
using DocSpring.Client.Client;
using DocSpring.Client.Model;

namespace Example
{
    public class DocSpringExample
    {
        public void main()
        {
          var apiInstance = new PDFApi();
          string dataRequestId = "drq_000000000000000001";
          UpdateSubmissionDataRequestData data = new UpdateSubmissionDataRequestData(
            authType: CreateSubmissionDataRequestData.AuthTypeEnum.Oauth,
            authProvider: "google",
            authSessionStartedAt: "2018-10-23T13:00:00Z"
          );
          var response = apiInstance.UpdateDataRequest(dataRequestId, data);
          Debug.WriteLine(response);
        }
    }
}

export DATA_REQUEST_ID="drq_000000000000000001"

curl -s -X PUT "https://api.docspring.com/api/v1/data_requests/$DATA_REQUEST_ID" \
  -u "$API_TOKEN_ID:$API_TOKEN_SECRET" -d \
    '{ "auth_type": "oauth", "auth_provider": "google", "auth_session_started_at": "2018-10-23T13:00:00Z" }'

results matching ""

    No results matching ""