POST
/
v2
/
export
/
connection
curl --request POST \
  --url https://api.usecloudpress.com/v2/export/connection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "destinationConnection": 123,
  "fieldMappings": {},
  "sourceConnection": 123,
  "sourceDocumentReference": "<string>",
  "title": "<string>"
}'
{
  "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
headerrequired

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

Body

application/json
destinationConnection
integer
required

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

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.

sourceConnection
integer
required

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

sourceDocumentReference
string
required

The reference of the document that must be exported. For Notion, this is the ID of the document.

title
string | null

An optional title for the exported content in the destination CMS. If none is specified, the title from the source document will be used.

Response

200 - application/json
id
string

The ID of the job.

outputDocuments
object[]

The documents that were created by this job.

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