Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "listId": "obl_7a3f21c9e5b04d68",
    "total": 512,
    "valid": 498,
    "invalid": 6,
    "duplicate": 5,
    "suppressed": 3,
    "list": {
      "id": "obl_7a3f21c9e5b04d68",
      "organizationId": "org_2Yh1kQ",
      "name": "Spring service reminders",
      "source": "csv",
      "rowsTotal": 512,
      "rowsValid": 498,
      "rowsInvalid": 6,
      "rowsDuplicate": 5,
      "rowsSuppressed": 3,
      "createdAt": "2026-07-13T15:04:00.000Z",
      "updatedAt": "2026-07-13T16:20:00.000Z"
    }
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Outbound

Import contacts into a list from a CSV (multipart)

Upload a CSV and a column mapping to import recipients. Each row’s phone is normalized to E.164 and validated; rows are deduplicated within the list and scrubbed against your opt-out list. Returns the per-import counts and the list’s new cumulative state. The columnMapping form field is a JSON object mapping canonical fields (phone [required], name, email, timezone, zip, appointment_time, priority) to the source column header; every other column becomes a merge variable. Use this to upload a CSV file. To import rows you already have as JSON (a paste or CRM sync), use addOutboundContacts (POST …/contacts) instead — same pipeline, different input format.

POST

/

outbound

/

lists

/

{id}

/

import

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "listId": "obl_7a3f21c9e5b04d68",
    "total": 512,
    "valid": 498,
    "invalid": 6,
    "duplicate": 5,
    "suppressed": 3,
    "list": {
      "id": "obl_7a3f21c9e5b04d68",
      "organizationId": "org_2Yh1kQ",
      "name": "Spring service reminders",
      "source": "csv",
      "rowsTotal": 512,
      "rowsValid": 498,
      "rowsInvalid": 6,
      "rowsDuplicate": 5,
      "rowsSuppressed": 3,
      "createdAt": "2026-07-13T15:04:00.000Z",
      "updatedAt": "2026-07-13T16:20:00.000Z"
    }
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

FlowClient Credentials

Token URL: /api/v1/api-keys

Scopes1

outbound:write

Create/import contact lists, create/launch/pause/resume/cancel outbound campaigns, and enqueue single outbound calls.

Path Parameters

id

string

required

The contact-list id to import into.

Body

multipart/form-data

file

file

required

The CSV file (first row = header). Max 16 MB.

columnMapping

string

required

A JSON object (sent as a form-field string) mapping canonical fields to source column headers, e.g. {"phone":"Phone","name":"First Name","appointment_time":"Visit"}.

Response

Import counts + the list's new state.

success

boolean

required

data

object

required

Show child attributes

message

string

errors

object[]

Show child attributes