Edit a contact, or unsubscribe them.

patch/v1/mailboxes/{mailboxId}/audiences/{audienceId}/contacts/{contactId}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token, scopes: email.write)
    • HTTP bearer

Path parameters

mailboxIdstring required
audienceIdstring required
contactIdstring required

Request body

firstNamestring

Display names are capped at 200 characters.

lastNamestring

Display names are capped at 200 characters.

unsubscribedboolean

Response

The request has succeeded.

idstring required
audienceIdstring required
emailstring required
firstNamestring nullable required
lastNamestring nullable required
unsubscribedboolean required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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