Export a Google Doc

curl --request POST \
  --url https://api.usecloudpress.com/v2/export/google-docs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'options={
  "destination": 123,
  "autoMapDocumentProperties": true,
  "conversion": {
    "destination": "<unknown>",
    "source": "<unknown>"
  },
  "destinationReference": "<string>",
  "fieldMappings": {},
  "webhooks": [
    "<string>"
  ]
}'

{
  "hasErrors": true,
  "hasWarnings": true,
  "id": "<string>",
  "outputDocuments": [
    {
      "links": [
        {
          "description": "<string>",
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "title": "<string>"
    }
  ],
  "queuedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "summary": "<string>",
  "type": "<string>"
}

POST

export

google-docs

Export a Google Doc

curl --request POST \
  --url https://api.usecloudpress.com/v2/export/google-docs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'options={
  "destination": 123,
  "autoMapDocumentProperties": true,
  "conversion": {
    "destination": "<unknown>",
    "source": "<unknown>"
  },
  "destinationReference": "<string>",
  "fieldMappings": {},
  "webhooks": [
    "<string>"
  ]
}'

{
  "hasErrors": true,
  "hasWarnings": true,
  "id": "<string>",
  "outputDocuments": [
    {
      "links": [
        {
          "description": "<string>",
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "title": "<string>"
    }
  ],
  "queuedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "summary": "<string>",
  "type": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

multipart/form-data

Google Doc Export request

file

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.

Show child attributes

options.destination

integer<int32>

required

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

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.

Show child attributes

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.destinationReference

string | null

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.

options.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.

Show child attributes

options.fieldMappings.{key}

object

Show child attributes

options.fieldMappings.{key}.propertyName

string | null

options.fieldMappings.{key}.value

object

Show child attributes

options.fieldMappings.{key}.value.hasValue

boolean

options.fieldMappings.{key}.value.value

unknown

options.webhooks

string[] | null

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

Response

Success

hasErrors

boolean

Indicates whether any errors occurred while executing the job.

hasWarnings

boolean

Indicates whether any warnings occurred while executing the job.

string<guid>

The ID of the job.

outputDocuments

object[]

The documents that were created by this job.

Show child attributes

outputDocuments.links

object[]

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

Show child attributes

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<date-time>

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.
failed - The job has failed.

Available options:

queued,

processing,

done,

failed

summary

string

Summary description of the job.

type

string

The type of job

Export from Connection Get Job Status

⌘I

API Documentation

Account

Connections

Collections

Export

Jobs

Convert

Document-Exports

Webhooks

Export a Google Doc

Authorizations

Body

Response