Skip to main content
The contacts command lets you manage contacts in your Loops audience.

​
create

Create a new contact. 
loops contacts create \
  --email alice@example.com \
  --first-name Alice \
  --list "cm06f5v0e45nf0ml5754o9cix=true"

​
Flags

FlagShortDescription
--email-eContact email address Required
--user-id-uUser ID
--first-nameFirst name
--last-nameLast name
--subscribed-sSubscribed status (true or false). We recommend leaving this field out unless you specifically want to unsubscribe or re-subscribe a contact. All new contacts are subscribed by default.
--user-groupUser group
--sourceSource (“API” by default)
--listMailing list subscription as id=true|false (repeatable)
--contact-propsPath to a JSON file of contact properties

​
Contact properties file

Use --contact-props to set custom properties from a JSON file:
props.json
{
  "planName": "Pro",
  "signupDate": "2025-01-15"
}

loops contacts create \
  --email alice@example.com \
  --contact-props ./props.json

​
update

Update an existing contact. Identify the contact by email or user ID. 
loops contacts update \
  --email alice@example.com \
  --first-name Alice \
  --last-name Smith \
  --list "cm06f5v0e45nf0ml5754o9cix=true"

​
Flags

FlagShortDescription
--email-eContact email address
--user-id-uUser ID
--first-nameFirst name
--last-nameLast name
--subscribed-sSubscribed status (true or false)
--user-groupUser group
--listMailing list subscription as id=true|false (repeatable)
--contact-propsPath to a JSON file of contact properties

​
find

Find a contact by email or user ID. 
loops contacts find --email alice@example.com

​
Flags

FlagShortDescription
--email-eContact email address
--user-id-uContact user ID

​
delete

Delete a contact by email or user ID. 
loops contacts delete --email alice@example.com

​
Flags

FlagShortDescription
--email-eContact email address
--user-id-uContact user ID

​
suppression check

Check whether a contact is on the suppression list. Identify the contact by email or user ID. 
loops contacts suppression check --email alice@example.com

​
Flags

FlagShortDescription
--email-eContact email address
--user-id-uContact user ID

​
suppression remove

Remove a contact from the suppression list. Identify the contact by email or user ID. 
loops contacts suppression remove --email alice@example.com

​
Flags

FlagShortDescription
--email-eContact email address
--user-id-uContact user ID
Last modified on April 7, 2026