Back to top

API Documentation

Triggers

Endpoints

Create a user-defined trigger

Create a user-defined trigger
POST/triggers

Example URI

POST /triggers
URI Parameters
HideShow
associations
string (required) Example: trigger.campaign
Request
HideShow
Body
{
  "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "event_type": "birthday",
  "action": "schedule_email",
  "wait_for": -604800,
  "campaign": "c39f338f-c24d-420d-98e9-cd5ba564fd14",
  "contact": "085d574a-57c6-4a6e-9ad1-99bab984a7c5"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f4f8f5c1-d1dc-4190-9864-dbc8a0052b31",
    "created_at": 1765163666.153479,
    "updated_at": 1765163666.153479,
    "deleted_at": null,
    "executed_at": null,
    "effective_at": 1765163666.153479,
    "failed_at": null,
    "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "brand": "50fd590c-64fa-4fda-99a0-d82fe3ce1828",
    "event_type": "birthday",
    "wait_for": -604800,
    "time": null,
    "action": "schedule_email",
    "recurring": false,
    "failure": null,
    "contact": "085d574a-57c6-4a6e-9ad1-99bab984a7c5",
    "deal": null,
    "flow_step": null,
    "brand_event": null,
    "campaign": {
      "id": "c39f338f-c24d-420d-98e9-cd5ba564fd14",
      "created_at": 1765163667.765799,
      "updated_at": null,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "50fd590c-64fa-4fda-99a0-d82fe3ce1828",
      "subject": "Email Subject",
      "include_signature": false,
      "html": "<div>Hi</div>",
      "due_at": null,
      "executed_at": null,
      "individual": false,
      "accepted": 0,
      "rejected": 0,
      "delivered": 0,
      "failed": 0,
      "opened": 0,
      "clicked": 0,
      "unsubscribed": 0,
      "complained": 0,
      "stored": 0,
      "text": "Hi",
      "headers": {},
      "google_credential": null,
      "microsoft_credential": null,
      "thread_key": null,
      "failed_at": null,
      "failed_within": null,
      "failure": null,
      "notifications_enabled": false,
      "archive": false,
      "tags": null,
      "recipients_count": null,
      "listed": true,
      "type": "email_campaign",
      "sent": 0
    },
    "scheduled_after": null,
    "type": "trigger",
    "origin": null
  }
}

Update a trigger

Update a trigger
PATCH/triggers/:id

Example URI

PATCH /triggers/:id
URI Parameters
HideShow
id
string (required) Example: f4f8f5c1-d1dc-4190-9864-dbc8a0052b31
Request
HideShow
Body
{
  "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "event_type": "home_anniversary",
  "wait_for": -691200,
  "campaign": "c39f338f-c24d-420d-98e9-cd5ba564fd14"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "f4f8f5c1-d1dc-4190-9864-dbc8a0052b31",
    "created_at": 1765163666.153479,
    "updated_at": 1765163666.153479,
    "deleted_at": null,
    "executed_at": null,
    "effective_at": 1765163666.153479,
    "failed_at": null,
    "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "brand": "50fd590c-64fa-4fda-99a0-d82fe3ce1828",
    "event_type": "home_anniversary",
    "wait_for": -691200,
    "time": null,
    "action": "schedule_email",
    "recurring": false,
    "failure": null,
    "contact": "085d574a-57c6-4a6e-9ad1-99bab984a7c5",
    "deal": null,
    "flow_step": null,
    "brand_event": null,
    "scheduled_after": null,
    "type": "trigger",
    "origin": null
  }
}

Get all triggers on a contact

Get all triggers on a contact
GET/contacts/:id?associations[]=contact.triggers

Example URI

GET /contacts/:id?associations[]=contact.triggers
URI Parameters
HideShow
id
string (required) Example: 085d574a-57c6-4a6e-9ad1-99bab984a7c5
associations
string (required) Example: contact.triggers
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "085d574a-57c6-4a6e-9ad1-99bab984a7c5",
    "display_name": "Johnny",
    "partner_name": "Jane Doe",
    "brand": "50fd590c-64fa-4fda-99a0-d82fe3ce1828",
    "brand_id": "50fd590c-64fa-4fda-99a0-d82fe3ce1828",
    "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "sort_field": "Johnny",
    "last_touch": null,
    "last_touch_action": null,
    "next_touch": null,
    "touch_freq": null,
    "ios_address_book_id": null,
    "android_address_book_id": null,
    "created_at": 1765163667.591811,
    "updated_at": 1765163666.153479,
    "deleted_at": null,
    "created_for": "direct_request",
    "updated_for": "direct_request",
    "deleted_for": null,
    "title": null,
    "first_name": "John",
    "partner_first_name": "Jane",
    "middle_name": "M.",
    "last_name": "Doe",
    "partner_last_name": "Doe",
    "marketing_name": null,
    "nickname": "Johnny",
    "email": "[email protected]",
    "primary_email": "[email protected]",
    "emails": [
      "[email protected]"
    ],
    "parked": false,
    "partner_email": "[email protected]",
    "phone_number": "+989124834198",
    "primary_phone_number": "+989124834198",
    "phone_numbers": [
      "+989124834198"
    ],
    "company": "Rechat",
    "birthday": "1970-01-12T00:00:00.000Z",
    "profile_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
    "cover_image_url": "https://inomics.com/sites/default/files/pictures/picture-95970-1460131169.png",
    "job_title": "Contact Test Subject",
    "source_type": "ExplicitlyCreated",
    "source": null,
    "website": [
      "http://www.gholi.com"
    ],
    "tags": [
      "poo",
      "foo",
      "New"
    ],
    "address": [
      {
        "city": "Dallas",
        "full": "Street, Dallas Texas 72890",
        "name": "Street",
        "type": "stdaddr",
        "extra": "Office",
        "line1": "Street",
        "line2": "Dallas Texas 72890",
        "state": "Texas",
        "country": "US",
        "postcode": "72890"
      }
    ],
    "triggers": [
      {
        "id": "f4f8f5c1-d1dc-4190-9864-dbc8a0052b31",
        "created_at": 1765163666.153479,
        "updated_at": 1765163666.153479,
        "deleted_at": null,
        "executed_at": null,
        "effective_at": 1765163666.153479,
        "failed_at": null,
        "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "brand": "50fd590c-64fa-4fda-99a0-d82fe3ce1828",
        "event_type": "home_anniversary",
        "wait_for": -691200,
        "time": null,
        "action": "schedule_email",
        "recurring": false,
        "failure": null,
        "contact": "085d574a-57c6-4a6e-9ad1-99bab984a7c5",
        "deal": null,
        "flow_step": null,
        "brand_event": null,
        "scheduled_after": null,
        "type": "trigger",
        "origin": null
      }
    ],
    "type": "contact"
  }
}

Delete a user-defined trigger

Delete a user-defined trigger
DELETE/triggers/:id

Example URI

DELETE /triggers/:id
URI Parameters
HideShow
id
string (required) Example: f4f8f5c1-d1dc-4190-9864-dbc8a0052b31
Response  204

Generated by aglio on 08 Dec 2025