Document Platform

Create a document relationship

post/customers/{customerId}/documents/{documentId}/relationships

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/documents/{documentId}/relationships
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
documentIdstring uuid required

Request body

targetDocumentIdstring uuid required
kind'latest_version_of' | 'supplemental_to' | 'attachment_of' | 'supersedes' required
subtype'side_letter' | 'deed_of_variation' | 'rent_review_memorandum' | 'licence_for_alterations' | 'wayleave_agreement' | 'statutory_declaration' | 'settlement_deed' | 'landlord_change_notice' | 'heads_of_terms' | 'other'

Response

Default Response

customerIdstring uuid required
sourceDocumentIdstring uuid required
targetDocumentIdstring uuid required
kind'latest_version_of' | 'supplemental_to' | 'attachment_of' | 'supersedes' required
createdAtunknown required
createdBystring required
subtype'side_letter' | 'deed_of_variation' | 'rent_review_memorandum' | 'licence_for_alterations' | 'wayleave_agreement' | 'statutory_declaration' | 'settlement_deed' | 'landlord_change_notice' | 'heads_of_terms' | 'other'
confidence'high' | 'medium' | 'low'
reasoningstring
status'suggested' | 'confirmed'

Changes

No recorded changes to this operation across all 1 revision of this API.