Skip to content

Update sending settings

PATCH/account/sending

Costs 2 rate-limit points · Rate limits

Change how the store sends email: the custom "from" address, whether copies of every invoice email go to the store and to which addresses, and the customer metafield that adds recipients. Deep partial: only the fields sent change. Returns the sending section as the read shows it.

Applies to every email sent from now on. A new from address is checked against the verified sending domains at once; from.verified in the response says whether it is in use. Copies, the metafield and the custom from address need a paid plan.

Also searched aschange the from addresssend invoice emails from my domainbcc me on invoicessend a copy of every invoicestop copying invoice emailsset the cc metafieldchange sender email

Request body

  • fromobject
    Show 1 child attributeHide child attributes
    • emailstring, nullable

      The address invoice emails come from. Its domain must be verified (DKIM) before it is used; until then emails go out from the Invoice Falcon address. Null returns to the default sender.

  • copiesobject
    Show 3 child attributesHide child attributes
    • enabledboolean

      Send a copy of every invoice email to the addresses in to.

    • tostring, nullable

      Addresses for the copies, separated by commas or semicolons.

    • customer_metafieldstring, nullable

      A Shopify customer metafield (namespace.key) holding extra recipients for that customer. Blank to stop using one.

Returns

  • fromobject
    Show 3 child attributesHide child attributes
    • emailstring
      Example: billing@acme.example
    • verifiedboolean
      Example: true
    • in_useboolean
      Example: true
  • copiesobject
    Show 4 child attributesHide child attributes
    • enabledboolean
      Example: true
    • tostring
      Example: a@acme.example, b@acme.example
    • customer_metafieldstring
    • to_addressesarray of strings
  • statusobject
    Show 2 child attributesHide child attributes
    • sending_allowedboolean
      Example: true
    • unlimited_sendingstring
      Example: standard

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

PATCH/account/sending
curl -X PATCH "https://app.invoicefalcon.com/api/v3/external/account/sending" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": {
      "email": "billing@acme.example"
    },
    "copies": {
      "enabled": true,
      "to": "a@acme.example, b@acme.example"
    }
  }'
Response
{
  "from": {
    "email": "billing@acme.example",
    "verified": true,
    "in_use": true
  },
  "copies": {
    "enabled": true,
    "to": "a@acme.example, b@acme.example",
    "customer_metafield": "",
    "to_addresses": [
      "a@acme.example",
      "b@acme.example"
    ]
  },
  "status": {
    "sending_allowed": true,
    "unlimited_sending": "standard"
  }
}