Home > API Reference > Document Preparation > Delete Document Field

Delete Document Field

Business applications can use this service API to delete a field of document in a package.

https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/fields

HTTP Verb

DELETE

Authorization

Bearer {access_token}

Content-Type

application/json

Accept

application/json

Response Headers

Request Body

{
 "field_name": "Text10"
}

Status Code

Message

Response Body 

200

OK

403  Forbidden 
{
  "Message": "You are not allowed to perform this action on locked workflow"
}
{
  "Message": "Account is disabled"
}

500

Internal Server Error

{
  "Message": "An internal server error occurred while processing the request"
}

The detail of each item provided in the request and response is provided below:

 Item Details
 Names
 Description
 Request Parameters:
 access_token The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges.

 package_id Package ID to which the document is added.

 document_id The document ID for which the action is to be taken.

 field_name Name of the field to be deleted. 

 Response Parameters:
 Message The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.






See also
Get Document Fields
Assign Document Field
Add Digital Signature Field
Add Electronic Signature Field
Add In-person Field
Add Initials Field
Add TextBox Field
Add RadioBox Field
Add CheckBox Field
Autoplace Fields
Update Digital Signature Field
Update Electronic Signature Field
Update In-person Field
Update Initials Field
Update TextBox Field
Update RadioBox Field
Update CheckBox Field