Create a new ImportContactsJob.

post

https://api.prtmb.com/api/v2/accounts/{account_id}/audiences/{audience_id}/import-contacts-jobs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

required

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

audience_id

required

This parameter indicates which Audience is referenced by the request.

As a convenience, the slug default may be used in place of the audience_id in any URL where it is
required. When default is used it will be replaced with the audience_id of the default audience
for the referenced Account.

Body Params

Success

Create a new ImportContactsJob.

items

array of objects

An array of objects to import as contacts.

items

muted

boolean

Defaults to false

A boolean indicating if the contacts should be muted after import.

update_existing

boolean

Defaults to false

A boolean value indicating if existing records should be updated by the import job.

For example, if an existing contact had the following values:

mobile_number: "+14045551234"
first_name: "Jon"

And the import job had an item with the following values:

mobile_number: "+14045551234"
first_name: "John"

The existing contact would only be updated when update_existing was true.

Response

Callback

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success