COcoevera
Email

EmailEvents.update

Changes fields of the EmailEvent record with the given id; fields left out keep their values.

patch/entities/EmailEvents/{id}

Request

Path parameters

idstring uuid required

Id of the EmailEvent record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

additional_dataobject

Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.

email_idstring uuid

Id of the email message.

type1 | 2 | 3 | 4 | 5 | 6

Kind of tracking event reported for the email, such as an open, a link click, a reply, an unsubscribe or a bounce.

Integer enum value: 1 - Open, 2 - Click, 3 - Unsubscribe, 4 - Bounce, 5 - Reply, 6 - BounceSoft

urlstring

URL the recipient interacted with. Set for click events; empty for other event types.

Example request

{
  "email_id": "01234567-abcd-dcba-ffff-000000000000",
  "type": 1,
  "url": "string"
}

Response

The changed EmailEvent record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "type": 1,
    "url": "string"
  }
}

Changes

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