Events

Track a custom event for a contact

Record a custom event, creating or updating the contact by email as a side effect. Requires a FULL (sk_*) key — SENDING_ONLY (pk_*) keys answer 403, since recording events is not sending mail. Reserved system event names (email.*, contact.subscribed/unsubscribed, segment.*.entry/.exit) are rejected.

Requires the events:write scope — Record custom events for your contacts.

post/api/track

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/track
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: events:write)

Request body

dataobject

Arbitrary JSON value (string, number, boolean, null, array, or object).

emailstring email required
eventstring required
subscribedboolean

Response

Event tracked

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.