API Documentation
Triggers ¶
Endpoints
Create a user-defined trigger ¶
Create a user-defined triggerPOST/triggers
Example URI
POST /triggers
URI Parameters
- associations
string(required) Example: trigger.campaign
Request
Body
{
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"event_type": "birthday",
"action": "schedule_email",
"wait_for": -604800,
"campaign": "d7380836-46f2-4b76-9e3f-9e3d36944b6f",
"contact": "732233a7-6b1a-4528-9624-4eae30661352"
}Response
200Body
{
"code": "OK",
"data": {
"id": "2b81313c-c2c7-4e14-bf79-9a22f25bbdc2",
"created_at": 1760470141.76773,
"updated_at": 1760470141.76773,
"deleted_at": null,
"executed_at": null,
"effective_at": 1760470141.76773,
"failed_at": null,
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"brand": "d62c7f30-e304-4fb8-a1f8-bae0be0ce9c6",
"event_type": "birthday",
"wait_for": -604800,
"time": null,
"action": "schedule_email",
"recurring": false,
"failure": null,
"contact": "732233a7-6b1a-4528-9624-4eae30661352",
"deal": null,
"flow_step": null,
"brand_event": null,
"campaign": {
"id": "d7380836-46f2-4b76-9e3f-9e3d36944b6f",
"created_at": 1760470143.430249,
"updated_at": null,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"brand": "d62c7f30-e304-4fb8-a1f8-bae0be0ce9c6",
"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 triggerPATCH/triggers/:id
Example URI
PATCH /triggers/:id
URI Parameters
- id
string(required) Example: 2b81313c-c2c7-4e14-bf79-9a22f25bbdc2
Request
Body
{
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"event_type": "home_anniversary",
"wait_for": -691200,
"campaign": "d7380836-46f2-4b76-9e3f-9e3d36944b6f"
}Response
200Body
{
"code": "OK",
"data": {
"id": "2b81313c-c2c7-4e14-bf79-9a22f25bbdc2",
"created_at": 1760470141.76773,
"updated_at": 1760470141.76773,
"deleted_at": null,
"executed_at": null,
"effective_at": 1760470141.76773,
"failed_at": null,
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"brand": "d62c7f30-e304-4fb8-a1f8-bae0be0ce9c6",
"event_type": "home_anniversary",
"wait_for": -691200,
"time": null,
"action": "schedule_email",
"recurring": false,
"failure": null,
"contact": "732233a7-6b1a-4528-9624-4eae30661352",
"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 contactGET/contacts/:id?associations[]=contact.triggers
Example URI
GET /contacts/:id?associations[]=contact.triggers
URI Parameters
- id
string(required) Example: 732233a7-6b1a-4528-9624-4eae30661352- associations
string(required) Example: contact.triggers
Response
200Body
{
"code": "OK",
"data": {
"id": "732233a7-6b1a-4528-9624-4eae30661352",
"display_name": "Johnny",
"partner_name": "Jane Doe",
"brand": "d62c7f30-e304-4fb8-a1f8-bae0be0ce9c6",
"brand_id": "d62c7f30-e304-4fb8-a1f8-bae0be0ce9c6",
"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": 1760470143.217871,
"updated_at": 1760470141.76773,
"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": "2b81313c-c2c7-4e14-bf79-9a22f25bbdc2",
"created_at": 1760470141.76773,
"updated_at": 1760470141.76773,
"deleted_at": null,
"executed_at": null,
"effective_at": 1760470141.76773,
"failed_at": null,
"user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"brand": "d62c7f30-e304-4fb8-a1f8-bae0be0ce9c6",
"event_type": "home_anniversary",
"wait_for": -691200,
"time": null,
"action": "schedule_email",
"recurring": false,
"failure": null,
"contact": "732233a7-6b1a-4528-9624-4eae30661352",
"deal": null,
"flow_step": null,
"brand_event": null,
"scheduled_after": null,
"type": "trigger",
"origin": null
}
],
"type": "contact"
}
}