Company logoTrust Center Documentation
API v1 ReferenceNda templatesIdVersionsVersionid

Update NDA template version

Update a specific version of an NDA template. Currently only supports publishing draft versions.

Publishing a draft version:

  • Changes the version status from "draft" to "published"
  • Makes the version immutable (read-only)
  • The version can then be activated to become the active version
PATCH
/api/v1/nda-templates/{id}/versions/{versionId}
AuthorizationBearer <token>

JWT token obtained from login endpoint

In: header

Path Parameters

idstring

Template ID

Formatuuid
versionIdstring

Version ID

Formatuuid
statusstring

Version status (currently only "published" is supported)

Value in"published"

Response Body

curl -X PATCH "https://app.orbiqhq.com/api/v1/nda-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "status": "published"  }'
curl -X PATCH https://app.orbiqhq.com/api/v1/nda-templates/550e8400-e29b-41d4-a716-446655440000/version/0d5340f6-8095-47e7-946b-5fad86710e96 \  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "status": "published"  }'
{
  "success": true,
  "message": "Version published successfully"
}

{
  "error": "Only draft versions can be published"
}

{
  "error": "Unauthorized"
}
{
  "error": "Version not found"
}
{
  "error": "Internal server error"
}

How is this guide?