Contact Events

Track contact interactions

Manage contact events

Create contact event

post

Submit custom event for contact

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

contact_identifierstring · uuid or emailRequired

Contact UUID or Email

Example: 018dd5e3-f6d2-7c00-8f9b-e5c3f2d8a132

Body

application/json

namestring · max: 255Optional

Responses

201

OK.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

422

Returns validation errors.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

post

/api/accounts/{account_id}/contacts/{contact_identifier}/events

Node.jsPHPPythonC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const event = await client.contacts.createEvent("contact_id", { name: "UserLogin", params: { user_id: 101, is_active: true } });
console.log(event);

{
  "contact_id": "018dd5e3-f6d2-7c00-8f9b-e5c3f2d8a132",
  "contact_email": "[email protected]",
  "name": "UserLogin",
  "params": {
    "user_id": 101,
    "user_name": "John Smith",
    "is_active": true,
    "last_seen": null
  }
}