Path Parameters
HTTP Header
api-key REQUIRED string - Your Accelerate API Key | URL Substitution
subdomain REQUIRED
relationship ID REQUIRED |
Relationship Document Requests
POST
POST - Insert a new document into a relationship
https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/documents/
Example Payload
POST
{
"description":"Template document",
"filename":"TestDoc.pdf",
"base64_document":"JVBERi0xLjMKJcTl8uXrp/Og0MTGCjMgMCBvYmoKPDwgL0Z..."
}
Response
400 Returned if the request sent is invalid. | 404 Returned if the request is not found or the user does not have permission to view it. |
201
|
Relationship Document Attributes
When updating/adding a new document via the API, there are a number of fields needed.
Mandatory Fields
Expand to see the list of mandatory fields
Expand to see the list of mandatory fields
description - string
filename - string
Must have a file extension
base64_document - string
Must be a valid base64 encoded string
Non Mandatory Fields
Expand to see the list of non-mandatory fields.
Expand to see the list of non-mandatory fields.
relationship_document_id - number
Must not be supplied when using POST .