documentv2

shareDocumentFile

Internal documentv2/shareDocumentFile operation. Authentication requirements are derived from the active route allowlist.

post/documentv2/shareDocumentFile

Request body

custom_messagestring

emailsstring[]

file_namestring

file_pdfstring

idinteger

include_detailsboolean

is_sharingboolean

send_overstring

Example request

{
  "custom_message": "Hey i am sending you the invoice u asked for",
  "emails": [
    "abrar.ahmed.andpercent@gmail.com"
  ],
  "file_name": "example_file_name",
  "file_pdf": "example_file_pdf",
  "id": 244334,
  "include_details": true,
  "is_sharing": true,
  "send_over": "email"
}

Response

Standard successful response envelope.

status'success' required

statusCodeinteger required

messagestring required

dataobject required

{"stackTrail":"components:schemas:SuccessEnvelope:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

Example response

{
  "statusCode": 200,
  "message": "OK"
}

Changes

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