Expire a Submission

Deletes the generated PDF, clears data that was submitted in the API request, and deletes any images. (Electronic signatures are retained for UETA and ESIGN compliance.)

Note: This API call requires a live API token.

HTTP Request

DELETE https://app.formapi.io/api/v1/submissions/<SUBMISSION_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 Code

var FormAPI = require("@formapi/formapi");

var config = new FormAPI.Configuration();
config.apiTokenId = "FORMAPI_TOKEN_ID";
config.apiTokenSecret = "FORMAPI_TOKEN_SECRET";
client = new FormAPI.Client(config);

client.expireSubmission("YOUR_SUBMISSION_ID", function(error, submission) {
  if (error) throw error;
  console.log(submission);
});
require 'form_api'

FormAPI.configure do |c|
  c.username  = ENV['FORMAPI_TOKEN_ID']
  c.password  = ENV['FORMAPI_TOKEN_SECRET']
end

formapi = FormAPI::Client.new
response = formapi.expire_submission('YOUR_SUBMISSION_ID')
puts response
import form_api

client = form_api.Client()
client.api_client.configuration.username = "FORMAPI_TOKEN_ID"
client.api_client.configuration.password = "FORMAPI_TOKEN_SECRET"

response = client.expire_submission('YOUR_SUBMISSION_ID')
puts response
<?php
$formapi = new FormAPI\Client();
$formapi->getConfig()->setUsername("FORMAPI_TOKEN_ID");
$formapi->getConfig()->setPassword("FORMAPI_TOKEN_SECRET");

$response = $formapi->expireSubmission('YOUR_SUBMISSION_ID');
echo $response;
using System;
using System.Diagnostics;
using FormApi.Client.Api;
using FormApi.Client.Client;
using FormApi.Client.Model;

namespace Example
{
    public class FormAPIExample
    {
        public void main()
        {
          Configuration.Default.Username = "yRaaR9JmTPtGX7EN";
          Configuration.Default.Password = "IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec";

          var apiInstance = new PDFApi();
          string submissionId = "sub_000000000000000001";
          Submission submission = apiInstance.ExpireSubmission(submissionId);
          Debug.WriteLine(submission);
        }
    }
}
curl -s -X DELETE "https://app.formapi.io/api/v1/submissions/YOUR_SUBMISSION_ID" \
  -u "YOUR_API_TOKEN_ID:YOUR_API_TOKEN_SECRET"

results matching ""

    No results matching ""