Praecise Platform
Menu

Rivier/ Reference/ contacts

Import contacts from a CSV file

post/crm/import

Import contacts from a CSV file. A dry run first reports what would happen; nobody becomes subscribed by being in a file unless the importer states the basis.

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:admin
Graphql
Mutation.contactsImportRun
Sdk
contacts.import.run
Cli
contacts import run

Request bodyapplication/json, required

  • csvstringrequired
    At most 20000000 characters.
  • mappingobject
  • dryRunboolean
    Default: true.
  • onExistingstring
    One of: skip, fill, overwrite. Default: fill.
  • tagslist of string
  • sourcestring
    Default: import. At most 80 characters.
  • countrystring
    At most 2 characters.
  • consentobject
    • channelstring
      One of: email, sms, whatsapp, phone. Default: email.
    • purposestring
      Default: marketing.
    • basisstringrequired
      At most 500 characters.
    • collectedAtstring
      At most 40 characters.
    • policyVersionstring
      At most 40 characters.

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown