Batch import contacts

curl --request POST \
  --url https://{notifuseDomain}/api/contacts.import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "contacts": [
    {
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Doe"
    },
    {
      "email": "[email protected]",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  ],
  "subscribe_to_lists": [
    "newsletter",
    "product_updates"
  ]
}
'

{
  "operations": [
    {
      "email": "[email protected]",
      "action": "create",
      "error": null
    }
  ],
  "error": null
}

POST

api

contacts.import

Batch import contacts

curl --request POST \
  --url https://{notifuseDomain}/api/contacts.import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "contacts": [
    {
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Doe"
    },
    {
      "email": "[email protected]",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  ],
  "subscribe_to_lists": [
    "newsletter",
    "product_updates"
  ]
}
'

{
  "operations": [
    {
      "email": "[email protected]",
      "action": "create",
      "error": null
    }
  ],
  "error": null
}

Authorizations

Authorization

string

header

required

API token for authentication

Body

application/json

workspace_id

string

required

The ID of the workspace

Example:

"ws_1234567890"

contacts

object[]

required

Array of contacts to import (create or update)

Minimum array length: 1

Show child attributes

contacts.email

string<email>

required

Email address of the contact

Example:

"[email protected]"

contacts.external_id

string | null

External identifier for the contact

Example:

"user_12345"

contacts.timezone

string | null

Timezone of the contact

Example:

"America/New_York"

contacts.language

string | null

Preferred language of the contact

Example:

"en-US"

contacts.first_name

string | null

First name of the contact

Example:

"John"

contacts.last_name

string | null

Last name of the contact

Example:

"Doe"

contacts.full_name

string | null

Full name of the contact (for systems that don't have separate first/last names)

Example:

"John Doe"

contacts.phone

string | null

Phone number of the contact

Example:

"+15551234567"

contacts.address_line_1

string | null

First line of address

Example:

"123 Main St"

contacts.address_line_2

string | null

Second line of address

Example:

"Apt 4B"

contacts.country

string | null

Country of the contact

Example:

"US"

contacts.postcode

string | null

Postal code

Example:

"10001"

contacts.state

string | null

State or province

Example:

"NY"

contacts.job_title

string | null

Job title of the contact

Example:

"Software Engineer"

contacts.custom_string_1

string | null

Custom string field 1

Example:

"Premium tier"

contacts.custom_string_2

string | null

Custom string field 2

contacts.custom_string_3

string | null

Custom string field 3

contacts.custom_string_4

string | null

Custom string field 4

contacts.custom_string_5

string | null

Custom string field 5

contacts.custom_number_1

number<float> | null

Custom number field 1

Example:

42

contacts.custom_number_2

number<float> | null

Custom number field 2

contacts.custom_number_3

number<float> | null

Custom number field 3

contacts.custom_number_4

number<float> | null

Custom number field 4

contacts.custom_number_5

number<float> | null

Custom number field 5

contacts.custom_datetime_1

string<date-time> | null

Custom datetime field 1

Example:

"2023-06-01T09:00:00Z"

contacts.custom_datetime_2

string<date-time> | null

Custom datetime field 2

contacts.custom_datetime_3

string<date-time> | null

Custom datetime field 3

contacts.custom_datetime_4

string<date-time> | null

Custom datetime field 4

contacts.custom_datetime_5

string<date-time> | null

Custom datetime field 5

contacts.custom_json_1

object

Custom JSON field 1 (must be a JSON object or array)

Example:

{
  "preferences": { "theme": "dark", "notifications": true }
}

contacts.custom_json_2

object

Custom JSON field 2 (must be a JSON object or array)

contacts.custom_json_3

object

Custom JSON field 3 (must be a JSON object or array)

contacts.custom_json_4

object

Custom JSON field 4 (must be a JSON object or array)

contacts.custom_json_5

object

Custom JSON field 5 (must be a JSON object or array)

Example:

[
  {
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe"
  },
  {
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Smith"
  }
]

Optional array of list IDs to subscribe all contacts to

Example:

["newsletter", "product_updates"]

Response

Batch import completed (may include partial failures)

operations

object[]

Array of operation results, one for each contact in the request

Show child attributes

operations.email

string<email>

Email address of the contact

Example:

"[email protected]"

operations.action

enum<string>

The action that was performed: 'create' for new contacts, 'update' for existing contacts, 'error' for failed operations

Available options:

create,

update,

error

Example:

"create"

operations.error

string | null

Error message if this specific contact operation failed

Example:

null

error

string | null

Global error message if the entire operation failed

Example:

null

Get a contact by external ID Delete a contact

⌘I

Transactional

Contacts

Lists

Custom Events

Broadcasts

Templates

Webhooks

Batch import contacts

Authorizations

Body

Response