Cloudpress App
Support
Cloudpress App

Export

Export a Google Doc

Documentation

Integrations

API Reference

Cloudpress website
Blog

Export

Export a Google Doc

Allows you to export a Google Doc to a destination connection. The export of the document will be handled on a background job and can take anywhere from a second to a couple of minutes to be processed.

POST

export

google-docs

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

object

Required

object

Google Doc Export request

file

string

file

Required

string

The JSON content of the Google Doc that must be exported. Can be retrieved via the Google Docs API.

options

object

options

Required

object

Options for the export which specifies details such as the connection the content must be exported to, the format of the content, etc.

autoMapDocumentProperties

boolean

autoMapDocumentProperties

boolean

Indicates whether Cloudpress should attempt to automatically map document properties to the underlying fields with the same names in the destination connection.

conversion

object

conversion

object

Optional configuration that determines how the source and destination content will be converted.

destination

Option 1 · null

destination

null

A configuration object that determines how the destination content will be converted.

source

Option 1 · null

source

null

A configuration object that determines how the source content will be converted.

destination

integer

destination

Required

integer

The ID of the connection to which the content must be exported.

destinationReference

string

destinationReference

string

An optional reference with the unique identifier (i.e. the primary key) of the content in the target CMS. By default, this will be managed automatically by Cloudpress and must not be specified. This is useful in a situation where you have existing content in the CMS that was created without Cloudpress and you wish Cloudpress to overwrite that particular piece of content with the content from the export.

fieldMappings

object

fieldMappings

object

Allows you to export additional fields to the destination connection. You can specify either explicit values, or you can map them to fields in the source document.

webhooks

array

webhooks

array

An optional list of webhook endpoints that must be called upon successful completion or failure of the export.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

file

string

required

The JSON content of the Google Doc that must be exported. Can be retrieved via the Google Docs API.

options

object

required

Options for the export which specifies details such as the connection the content must be exported to, the format of the content, etc.

options.autoMapDocumentProperties

boolean | null

Indicates whether Cloudpress should attempt to automatically map document properties to the underlying fields with the same names in the destination connection.

options.conversion

object

Optional configuration that determines how the source and destination content will be converted.

options.conversion.destination

any | null

A configuration object that determines how the destination content will be converted.

options.conversion.source

any | null

A configuration object that determines how the source content will be converted.

options.destination

integer

required

The ID of the connection to which the content must be exported.

options.destinationReference

string | null

options.fieldMappings

object | null

Allows you to export additional fields to the destination connection. You can specify either explicit values, or you can map them to fields in the source document.

options.webhooks

string[] | null

An optional list of webhook endpoints that must be called upon successful completion or failure of the export.

Response

200 - application/json

string

The ID of the job.

outputDocuments

object[]

The documents that were created by this job.

outputDocuments.links

object[]

A list of links that allow you to navigate to the exported document on the destination connection.

outputDocuments.links.description

string

The description of the link.

outputDocuments.links.title

string

The title of the link.

outputDocuments.links.url

string

The URL for the link.

outputDocuments.title

string

The title of the document

queuedAt

string

The date and time that the job was queued for processing.

status

enum<string>

The status of the job. Possible values:

queued - The job has been queued and is waiting to be processed.`
processing - The job is being processed.`
done - The job has completed successfully.
error - The job has completed with errors.

Available options:

queued,

processing,

done,

error

summary

string

Summary description of the job.

type

string

The type of job

Export from Connection Get Job Status

twitter github youtube

API Documentation

Account

Connections

Collections

Export

Jobs

Convert

Document-Exports

Webhooks

Authorizations

Body

Response