Events

Mark emails with events types

post/api/v1/emails/events

Request

  • Base URL: https://api.ratingcaptain.com
  • URL: https://api.ratingcaptain.com/api/v1/emails/events
  • Auth: API key in header api-token

Headers

api-tokenstring
website-tokenstring

Request body

event'sent_email' | 'opened_email' | 'opened_product_email' required

Event that occure in external system. Available events <br> <strong>sent_email</strong> - Email was sent <br> <strong>opened_email</strong> - Email was opened <br> <strong>opened_product_email</strong> - Product email was opened.

ratingcaptain_email_idnumber

This field is required when <code>external_id</code> is not present.

external_idstring

This field is required when <code>ratingcaptain_email_id</code> is not present.

Example request

{
  "event": "opened_email",
  "ratingcaptain_email_id": 185405695.04
}

Response

messagestring

Example response

{
  "message": "Event processed successfully",
  "rate": {
    "id": 4274755,
    "website_id": 74,
    "email": "example@example.com",
    "link": "https://www.examle.com",
    "template_id": 57,
    "send_date": "2023-01-06",
    "is_send": 1,
    "click": 0,
    "active": 1,
    "deleted_at": null,
    "created_at": "2022-12-30T09:00:18.000000Z",
    "updated_at": "2022-12-30T10:08:25.000000Z",
    "hash": "0d0a78fc13c887faa1cb2845d1452bdb",
    "data": "[]",
    "country": "PL",
    "order_lang": null,
    "reaction": null,
    "user_message": null,
    "external_id": "12345667",
    "click_date": null,
    "products_email_date": null,
    "rabat_send": 0,
    "rabat_code": null,
    "reaction_seen": 0,
    "name": null,
    "surname": null,
    "sign_out": 0,
    "respond_history": [],
    "done": 0,
    "type": null,
    "session_id": null,
    "click_history": [],
    "phone": "555666777",
    "sent_by_sms": 0,
    "platform_id": 3404,
    "coupon_sent_at": null,
    "sent_by_redirect": 0,
    "from_popup": 0,
    "opened_at": "2022-12-30 10:08:25",
    "from_qr_code": false,
    "send_sms_date": "2023-01-06",
    "order_source": "default",
    "click_date_diff": null,
    "import": null,
    "has_default_id": true,
    "products_rate_link": "https://example.com/product_link",
    "hasAnyUserMessage": false,
    "products_email_date_calculated": "None",
    "like_link": "https://example.com/like_link",
    "dislike_link": "https://example.com/dislike_link",
    "chat_link": "https://example.com/chat_link",
    "predict_send_date": null
  }
}

Changes

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