Add a contact to an audience.

post/v1/mailboxes/{mailboxId}/audiences/{audienceId}/contacts

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

Request body

emailstring required

Validated as an address shape — a value with no @ answers 422.

firstNamestring

Display names are capped at 200 characters.

lastNamestring

Display names are capped at 200 characters.

Response

The request has succeeded and a new resource has been created as a result.

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.