Upload Document
Last updated
Last updated
This tutorial should help you upload the first Document. Before moving forward, make sure your Authentication works and you understand the Key Concepts of the Pipeliner API, and make sure you know how to use API parameters
The Documents represent the physical file (.docx, .pdf, etc.) that can be linked to records in Pipeliner
Upload Document to the Account.
filename
Name of the Document
content
The image in base64 encoded string value.
type
Required. Integer enum values are:
1 – S3File (recommended - Pipeliner Storage)
2 – S3Image (Pipeliner Storage),
3 – GoogleDriveFile,
4 – OneDriveFile,
5 – BoxFile,
6 – DropboxFile,
7 – SharepointFile,
8 – ExternalURL.
As we are going to upload document to a specific account, we need to retrieve its ID
Uploading document consists of two steps, but we can actually accomplish this in one request:
Upload document to the Storage
Link Document to Account
In this step, we will upload a document and immediately link that to the Account
It is recommended to include the File Type in the file name of the document (like *.pdf, *.jpg). Then Pipeliner can automatically recognize the format that helps sales people with the opening of documents
If you wish to upload files that are stored in external storage like (Sharepoint, Google drive) you can do that by changing the type
attribute. In our case, we are going to Upload a document to Pipeliner that is stored on Google Drive storage.
The list of all types
1 – S3File (recommended - Pipeliner Storage)
2 – S3Image (Pipeliner Storage),
3 – GoogleDriveFile,
4 – OneDriveFile,
5 – BoxFile,
6 – DropboxFile,
7 – SharepointFile,
8 – ExternalURL.
For Uploading external files, you need to specify the url
instead of content
attribute
Creates new cloudobjectrelation
data of new CloudObjectRelation
Last modification time.
"2019-01-01T00:00:00"
Creation time.
"2019-01-01T00:00:00"
Relation to CloudObject, see: 'createCloudObjectInput' object for properties.
Relation to ReportSchedule, see: 'createReportScheduleInput' object for properties.
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single abstract entity instance. E.g. Relation to Lead/Oppty
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single abstract entity instance. E.g. Relation to Lead/Oppty
"01234567-abcd-dcba-ffff-000000000000"
Relation to single abstract entity instance. E.g. Relation to Lead/Oppty
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Revision when entity was lastly changed.
1
Creation confirmation. Returns created cloudobjectrelation
True when response succeeded, false on error.
true