logo

Contact Lists

Contact lists are a collection of contacts that can be used to target campaigns.

Contact lists are created in the Movio EQ application. Once created, a contact list can be used to target campaigns. The contact list can be appended to, replaced, or deleted programmatically using the API.

Update Contacts

The contacts will be updated in the contact list. Only the contacts that are specified in the request will be modified in the contact list. Any contacts that are not set will remain unchanged in the contact list.

SecurityOAuth2
Request
path Parameters
contactList_id
required
string (ContactList_id)

The unique identifier for a contact list.

Example: 12345
query Parameters
action
required
string

The action to perform on the contact list.

Enum: "append" "replace" "delete"
Example: action=append
Request Body schema: application/json

The contact list to be updated.

Array
email
required
string (Email)

A generic email address. We don't validate the email addresses before they are actively used in the system. When sending an email to the address, we get signals from the receiving part (fx gmail, apple, microsoft, etc.). Based on these signals we can determine if the email address is valid or not. If the email address is invalid, then it will be categorised as a soft_bounce or hard_bounce.

Soft Bounces

A soft_bounce is when the email address is temporarily unavailable. A soft_bounce can become a hard_bounce if the email address is tried multiple times but is soft_bounced every time.

Hard Bounces

A hard_bounce is when the email address is permanently unavailable. If a hard_bounce is received, then the email address will be marked as invalid and will not be used in the system. This can be reversed by contacting Movio support.

attributes*
additional property
string

Any additional attributes of the contact. This could be the likes of a first name, last name, latest purchase date, etc. Anything that could be useful for targeting campaigns.

Responses
202

The updated contact list.

400

The request could not be understood by the server due to malformed syntax.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

put/contact-lists/{contactList_id}/contacts
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]