v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-212974381.2 MB

exports

Create Public Export Job Compat

Create an export job.

Integration-destination exports are validated against the runnable delivery matrix. HubSpot Company, Contact, Custom Object, Deal, Invoice, Item, Order, Subscription, and Ticket exports use the dedicated Hatchet bulk workflow, bounded CSV chunks, and HubSpot's Imports API. Invoice requires an explicitly selected HubSpot custom-object type id. NextEngine Item and Order exports keep their dedicated Hatchet pipelines. Provider and object pairs without a working delivery pipeline are rejected with HTTP 400 and error code INTEGRATION_EXPORT_NOT_SUPPORTED before any job history row is created. Empty or unknown provider slugs are rejected with INTEGRATION_EXPORT_UNKNOWN_PROVIDER. Accepted jobs stay queued or running until provider completion and required post-processing finish.

post/v2/public/exports

Query parameters

workspace_idstring nullable

Headers

X-Workspace-Codestring

Request body

object_typestring required

destination_kindstring

providerstring nullable

target_systemstring nullable

channel_idstring nullable

mapping_template_idstring nullable

mapping_template_revisioninteger nullable

mapping_template_stateobject nullable

operationstring

request_invoiceboolean

record_idsstring[] nullable

workspace_scopestring nullable

view_idstring nullable

search_querystring nullable

idempotency_keystring nullable

custom_object_idstring nullable

limitinteger

file_formatstring nullable

dry_runboolean

workflow_action_tracker_idstring nullable

action_tracker_idstring nullable

workflow_languagestring nullable

key_fieldstring nullable

export_set_itemsboolean

set_code_sourcestring nullable

mapping_custom_fieldsobject nullable

mapping_custom_fields_conditionalobject nullable

{"stackTrail":"components:schemas:ExportJobCreateRequest:properties:update_hubspot:anyOf","oasType":"schema","type":"unknown","title":"Update Hubspot","nullable":true}

hubspot_follow_up_channel_idstring nullable

hubspot_follow_up_deal_stagestring nullable

mapping_typestring nullable

selected_custom_objectstring nullable

Response

Successful Response

successtrue required

dataobject required