Home > API Reference > Document Package > Change Document Package Owner

Change Document Package Owner

Business applications can use this service API to change the owner of a document package.  The new owner must be part of the same Enterprise as the current owner, and must be in an active state.

The document package must be in either In-Progress or Completed state.

The document package ID is supplied in the URL.

Only the current document owner or an Enterprise Admin can use this method.  If an Enterprise Admin is using this call then the access token must be obtained using the scope parameter of the current document owner. 

https://api.signinghub.com/v3/packages/{package_id}/owner

HTTP Verb

PUT

Content-Type

application/json

Accept

application/json

Authorization

Bearer {access_token}

Request Body

{
  "owner": "john_doe@gmail.com"
}         

Status Code

Message

Response Body

200  OK  

401

Unauthorized

{
  "Message": "User authentication required"
}

403

Forbidden

{
  "Message": "Document does not belong to user"
}
{
  "Message": "Enterprise admin's role does not allow managing integration"
}
{
  "Message": "You are not allowed to perform the requested operation"
}
{
   "Message": "Account is disabled"
}

404

Not Found

{
  "Message": "Document not found"
}
{
  "Message": "Document does not exist"
}

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. The "scope" parameter must be used in the authentication request when the Enterprise Admin credentials are used to change the owner of a document of an Enterprise User.

 package_id
The ID of the document package to change.

 owner Email address of the new owner.
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
Add Package
Rename Package
Upload Document
Add Document from Library
Apply Workflow Template
Share Document Package
Get Document Details
Get Document Image
Get Document Image (base64)
Download Document
Download Document (base64)
Rename Document
Delete Document
Get Certify Policy for a document
Update Certify Policy for a document
Get Package Verification
Get Document Verification
Change Document Order
Get Packages
Delete Package
Download Package
Download Package (base64)
Open Document Package
Close Document Package