v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

EmailEvents.update

Modifies EmailEvent or EmailEvents with given id(s)

patch/entities/EmailEvents/{id}

Path parameters

idstring uuid required

ID of EmailEvent to update

Query parameters

validation-levelinteger

Specify validation level of EmailEvent on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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

Field whose values are strictly defined with an enumeration of values.

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

Modification confirmation. Returns resulting EmailEvent

successboolean

True when response 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"
  }
}