---
title: "EmailEvents.update"
method: PATCH
path: "/entities/EmailEvents/{id}"
tags: ["Email"]
---

# EmailEvents.update

`PATCH /entities/EmailEvents/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/EmailEvents/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/EmailEvents/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateEmailEventInput: Field values to change on an EmailEvent record; fields left out keep their values.
  - `additional_data` object: Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.
  - `email_id` string, uuid: Id of the email message.
  - `type` 1 | 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
  - `url` string: URL the recipient interacted with. Set for click events; empty for other event types.

## Response `200`

The changed EmailEvent record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` EmailEvent: Tracking event reported for a sent email, such as an open, a link click, a reply or an unsubscribe.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `email` string, uri, required: Email message the event was reported for. Related Email record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Email' for its fields.
    - `additional_data` object: Provider-specific extra data captured with the event (e.g. user agent, ip), as a JSON document.
    - `email_id` string, uuid, required: Id of the email message.
    - `type` 1 | 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
    - `url` string: URL the recipient interacted with. Set for click events; empty for other event types.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)