Email sending

Update email identity

Update the name or default status of an email identity.

patch/orgs/emails/identities/{identity_id}

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/emails/identities/{identity_id}
  • Auth: HTTP bearer

Path parameters

identity_idstring required

The ID of the email identity

Request body

namestring

Display name for the identity

is_defaultboolean

Set as the default identity for the org

click_trackingboolean

Enable or disable click tracking

open_trackingboolean

Enable or disable open tracking

Response

idstring required

Unique identifier for the email identity

emailstring required

Email address of the identity

namestring nullable required

Display name for the identity

status'PENDING' | 'VERIFIED' | 'FAILED' required

Verification status of an email identity

is_defaultboolean required

Whether this is the default identity for the org

click_trackingboolean required

Whether click tracking is enabled for this identity

open_trackingboolean required

Whether open tracking is enabled for this identity

verified_atstring date-time nullable required

Timestamp when the identity was verified

created_atstring date-time nullable required

Timestamp when the identity was created

updated_atstring date-time nullable required

Timestamp when the identity was last updated

Changes

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