Activate an NDA template version
Activates a specific published version of an NDA template, making it the active version that contacts will sign. This operation:
- Deactivates all other versions (sets is_active to false)
- Activates the specified version (sets is_active to true)
- Updates the template status to "published"
Only published versions can be activated. Attempting to activate a draft version will return an error.
AuthorizationBearer <token>
JWT token obtained from login endpoint
In: header
Path Parameters
idstring
Template ID
Format
uuidversionIdstring
Version ID to activate
Format
uuidResponse Body
curl -X POST "https://app.orbiqhq.com/api/v1/nda-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08/activate"curl -X POST https://app.orbiqhq.com/api/v1/nda-templates/550e8400-e29b-41d4-a716-446655440000/versions/0d5340f6-8095-47e7-946b-5fad86710e96/activate \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"id": "0d5340f6-8095-47e7-946b-5fad86710e96",
"key": "draft_1706189400000",
"name": "v3",
"status": "published",
"is_active": true,
"date_created": "2024-01-25T12:30:00Z",
"date_updated": "2024-01-25T13:00:00Z"
}{
"type": "invalid_request_error",
"code": "version_not_published",
"message": "Only published versions can be activated",
"doc_url": "https://docs.orbiqhq.com/errors/version_not_published"
}{
"type": "authorization_error",
"code": "unauthorized",
"message": "Invalid or missing authentication token",
"doc_url": "https://docs.orbiqhq.com/errors/unauthorized"
}{
"type": "invalid_request_error",
"code": "version_not_found",
"message": "Version not found or does not belong to this template",
"doc_url": "https://docs.orbiqhq.com/errors/version_not_found"
}{
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred",
"doc_url": "https://docs.orbiqhq.com/errors/internal_error"
}How is this guide?