Skip to main content
POST
Start an import job

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

source
string
required

Body

application/json
envelope
string
required

Encrypted credentials envelope returned by the connect / manual-credentials step.

entities
string[]
required

Entity kinds to import (e.g. phone_numbers, contacts, messaging_services).

Required array length: 1 - 10 elements
conversationDays
integer

Optional lookback window for conversation history (Twilio caps this at 90 days).

Required range: 1 <= x <= 90
conflictPolicy
object

Optional per-entity conflict policy keyed by entity kind.

Response

The import job was accepted and queued; the payload carries the new job id and its initial status.

data
object
meta
object