Keeping contacts in sync with the API

The widget tells UserSignal about people while they use your product. The Management API covers everything else, from your own server: people who sign up on mobile, people who stop visiting, things that happen in the background, and opt-outs.

Create a token in Settings › API. The same page has the full guide with examples.

Contacts

• Create or update one contact, or up to 100 at a time, with their email, name, language, country, tags and any properties.
• Use your own user ID, so the contact matches the person in your app and in the widget.
• Set subscribed to say whether they agreed to marketing email.
• Delete a contact when the account is closed.

An address sent through the API counts as confirmed by you, so the contact can be emailed.

Events

Report what a person did, such as signed_up, first_payment or cancelled. Events start automations and can be used in segments. An event can carry the time it happened; one older than 24 hours is stored but starts nothing.

People who must not be emailed

• Send the addresses that unsubscribed, bounced or complained in the email tool you used before, so your first sends here don't reach them.
• Read who unsubscribed, complained or bounced here, to keep your own records in step.

Campaigns you sent before

If you are moving from another email tool, you can bring in the campaigns you already sent, with who opened and clicked, so your history is in one place. They are marked "Another tool" and don't count towards your sending reputation here.

Do I need the API?

Not to start. With the widget and identity verification, people who use your web app are already contacts you can email. Add the API when you need the cases above.