Authentication is required.


GET /api/v2/contact-lists
List all contact lists


GET /api/v2/contact-lists/:id
Show a contact list

Params

Param name Description
id
required

Contact list ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/contact-lists
Post a contact list

Params

Param name Description
data
required

Contact list information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][name]
required

Contact list's name

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][entity]
required

Validations:

  • Must be a Hash

data[relationships][entity][data]
required

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
required

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
required

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/contact-lists/:id/remove
Soft-Remove the contact list

Params

Param name Description
id
required

Contact list ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/contact-lists/:id
Update contact list name

Params

Param name Description
id
required

Contact list ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Contact list information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][name]
optional

Contact list's name

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
optional

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/contact-lists/:id/add-contacts
Add Account/Investor to contact list

Params

Param name Description
id
required

Contact list ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Contact list information

Validations:

  • Must be a Hash

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][contactables]
optional

Validations:

  • Must be a Hash

data[relationships][contactables][data]
optional , nil allowed

Validations:

  • Must be an Array of nested elements

data[relationships][contactables][data][type]
optional

`entities` | `target-investors`

Validations:

  • Must be a String

data[relationships][contactables][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/contact-lists/:id/remove-contacts
Remove Account/Investor from contact list

Params

Param name Description
id
required

Contact list ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Contact list information

Validations:

  • Must be a Hash

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][contactables]
optional

Validations:

  • Must be a Hash

data[relationships][contactables][data]
optional , nil allowed

Validations:

  • Must be an Array of nested elements

data[relationships][contactables][data][type]
optional

`entities` | `target-investors`

Validations:

  • Must be a String

data[relationships][contactables][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/contact-lists/:id/import-contacts-from-csv
import Account/Investor from contact list from csv

Params

Param name Description
id
required

Contact list ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Contact list information

Validations:

  • Must be a Hash

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][csv-source]
optional

CSV content

Validations:

  • Must be a String