TextKitDocs

Ways to bring an audience in

Where an audience can come from and every way to bring it here.

GET/v1/contacts/import/sources

Query Parameters

  • sourcestring

    Where the people are, in your words. Omit to get the questions first.

Details

Without source: the questions to ask (where the people are, which group, what you can sign in to, whether consent was recorded, once or synced) and the kinds of source we know. With source (free text, e.g. "Mixpanel" or "our Postgres users table"): the ways in, best first: an integration already syncing it, tools you already have for it, our 6-hourly sync, connected with your key here or in the console, a push to an ingest URL, a script against its API with a key from your environment, its export screen, and the console upload.

Also lists the integrations already connected. Reads nothing else and changes nothing.

Responses

  • 200JSON object

    The import plan

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectimport_plan
  • sourceobject

    Nullable.

  • source.keystring
  • source.labelstring
  • source.kindstring
  • source.syncedboolean

    We have our own sync for it

  • source.consentstring

    Where it records SMS consent Nullable.

  • questionsarray of string
  • connectedarray of object
  • connected[].idstring
  • connected[].providerstring
  • connected[].namestring
  • connected[].statusstring
  • connected[].list_idstring
  • pathsarray of object
  • paths[].methodconnected, your_tools, integration, push, api, export, upload
  • paths[].titlestring
  • paths[].whenstring
  • paths[].stepsarray of string
  • paths[].console_urlstring

    The console page for this way in

  • consentstring

    How consent carries over

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded