FAfactify-inc
Versions

Update a version

Changed on

Update version title and description.

patch/v1beta/versions/{version_id}

Request

  • Base URL
    https://api.factify.com
  • URL
    https://api.factify.com/v1beta/versions/{version_id}
  • Auth
    HTTP bearer

Path parameters

version_idstring required

Version ID to update. Pattern: ver_[0-9a-hjkmnp-tv-z]{26}

Request body

descriptionstring nullable

New description.

titlestring nullable

New title (max 255 characters).

Response

Success

created_atstring date-time required

Timestamp when version was created.

descriptionstring nullable

Description of changes in this version.

document_idstring required

Parent document ID. Pattern: doc_[0-9a-hjkmnp-tv-z]{26}

idstring required

Unique ID for the version. Pattern: ver_[0-9a-hjkmnp-tv-z]{26}

processing_status'processing' | 'ready' | 'failed' required
titlestring nullable

Optional version title.

urlstring uri required

URL for accessing this version on Factify.

Example response

{
  "created_by": {
    "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
  },
  "document_id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
  "id": "ver_01h2abcd1234efgh5678jkmnpt",
  "title": "Version 2.0",
  "url": "https://app.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41/v/1"
}

Changes

  • cb42a69ce465Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • a7e69986914eRevision changes
    • warning

      added the new bot enum value to the / response property for the response status

    • warning

      added the new user enum value to the / response property for the response status

    • info

      added discriminator to response property for the response status

    • info

      removed the service_account enum value from the / response property for the response status

    • info

      removed the user_account enum value from the / response property for the response status

    • info

      the / response's property pattern was changed from ^(user|svc)_[0-9a-hjkmnp-tv-z]{26}$ to ^(user|bot)_[0-9a-hjkmnp-tv-z]{26}$ for the status