UPupguard
trust_exchange

Create content library document

Changed on

Creates a new document in the organization's content library via multipart file upload.

Required API key permissions: TrustExchange and ReadWrite (select when creating API key in Account Settings)

post/trust_exchange/content_library/document

Request

Query parameters

document_namestring required

The name of the document.

document_typestring required

The document type (e.g. SOC 2 Report, ISO 27001, etc.). This must match an exist document type available for your organization.

document_descriptionstring

A description of the document.

public_trust_page_accessstring

Set whether this document should be accessible without access requests if it is added to a published Trust Center. Leave this param unset to use your organization's default access protection setting.

Request body multipart/form-data

filestring binary required

The file to upload.

Response

A single content library document.

archivedboolean

Whether the document is archived.

created_atstring date-time

When the document was created.

created_by_emailstring

The email of the user who created this document.

created_by_namestring

The name of the user who created this document.

descriptionstring

The description of the document.

document_typestring

The document type.

expires_atstring date-time

The expiration date of the document, if set.

internal_notesstring

Internal notes only visible to your organization.

namestring

The name of the document.

published_trust_center_uuidsstring[]

UUIDs of published Trust Centers where this document is included.

unpublished_trust_center_uuidsstring[]

UUIDs of unpublished Trust Centers where this document is included.

updated_atstring date-time

When the document was last updated.

updated_by_emailstring

The email of the user who last updated this document.

updated_by_namestring

The name of the user who last updated this document.

usage_countinteger

The number of times this document has been used. For example, added to a Trust Center, or used in a questionnaire.

uuidstring

The unique identifier for the document.

Example response

{
  "created_at": "2024-03-20T15:30:00Z",
  "created_by_email": "jane@example.com",
  "created_by_name": "Jane Smith",
  "description": "Our latest SOC 2 Type II report covering the period...",
  "document_type": "SOC 2 Report",
  "internal_notes": "Document awaiting update...",
  "name": "Q4 2024 SOC 2 Report",
  "updated_at": "2024-03-20T15:30:00Z",
  "updated_by_email": "john@example.com",
  "updated_by_name": "John Doe",
  "usage_count": 5,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "versions": [
    {
      "created_at": "2024-03-20T15:30:00Z",
      "filename": "soc2_report_q4_2024.pdf",
      "version": 3,
      "virus_safe": true
    }
  ]
}

Changes