Docs
Management API
Email Statuses

Email Statuses

Get Transactional Email Settings

GET /settings/email-statuses

Request

Get global transactional email settings or channel specific overrides by channel_id.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • channel_id in query - integer

    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

example

Response

OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Example

Update Transactional Email Settings

PUT /settings/email-statuses

Request

Update global transactional email settings or create channel specific overrides by channel_id.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

  • channel_id in query - integer

    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | application/json
  • abandoned_cart_email
    boolean

  • account_details_changed_email
    boolean

  • combined_order_status_email
    boolean

  • create_account_email
    boolean

  • create_guest_account_email
    boolean

  • gift_certificate_email
    boolean

  • invoice_email
    boolean

  • order_message_notification_email
    boolean

  • product_review_email
    boolean

  • return_confirmation_email
    boolean

  • return_statuschange_email
    boolean

Example

Response

OK

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Example

Did you find what you were looking for?