Objects

PushDocument

Fields

• external_idstringrequired

  Your stable document ID. Sending the same ID replaces the document.

  length ≤ 512

• titlestringrequired

  length ≤ 500

• urlstring

  Link to the document in your system (http or https).

• contentstring

  Content (up to 5 MB).

• content_typestring

  Allowed values: htmlmarkdowntext

  Default: "html"

• patharray of string | string

  Folders of the document: an array of names or a string separated by “/” (up to 10 levels).

• permissionsPushPermissions
• tagsarray of string

  items ≤ 50

• author_emailstring

  Author. Becomes the owner of the card if this is a Sursa user.

• updated_atstring (date-time)

  Modification time in your system (part of the document version).

• metadataMetadataPatch

  metadata of the document's card (since 1.62.0): the object replaces the card's previous one, {} removes all pairs; without the metadata field, the card's metadata does not change.

• categorystring

  Category of the card: the key of an organization category (GET /v1/categories), since 1.62.0.

  length ≤ 64

• verifiersPushVerifiers
• verify_interval_daysinteger

  Verification interval of the card in days (since 1.62.0); without it, the source's interval.

  ≥ 1, ≤ 3650

• upload_idstring

  File of the document from a multipart upload (upl_…, since 1.62.0) instead of content. An upload is used once; sending the same document with the same upload_id again does not use it up. While multipart uploads are not available on the installation, the document is rejected with reason file_rejected.

  length ≤ 64

• attachmentsarray of string

  Attachments of the document as multipart uploads (upl_…, since 1.62.0): each becomes its own card of the source with the same folder, permissions and card fields. An attachment missing from a new version of the document is archived.

  items ≤ 20

Used by

• POST/v1/push/sources/{source_id}/documentsSend a document (create or replace)

Part of

PushDocumentBatch