Update sending settings
/account/sendingCosts 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
fromobjectShow 1 child attributeHide child attributes
emailstring, nullableThe 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.
copiesobjectShow 3 child attributesHide child attributes
enabledbooleanSend a copy of every invoice email to the addresses in
to.tostring, nullableAddresses for the copies, separated by commas or semicolons.
customer_metafieldstring, nullableA Shopify customer metafield (namespace.key) holding extra recipients for that customer. Blank to stop using one.
Returns
fromobjectShow 3 child attributesHide child attributes
emailstringExample:billing@acme.exampleverifiedbooleanExample:truein_usebooleanExample:true
copiesobjectShow 4 child attributesHide child attributes
enabledbooleanExample:truetostringExample:a@acme.example, b@acme.examplecustomer_metafieldstringto_addressesarray of strings
statusobjectShow 2 child attributesHide child attributes
sending_allowedbooleanExample:trueunlimited_sendingstringExample:standard
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
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.
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"
}
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/sending", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"from": {
"email": "billing@acme.example"
},
"copies": {
"enabled": true,
"to": "a@acme.example, b@acme.example"
}
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.invoicefalcon.com/api/v3/external/account/sending",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"from": {
"email": "billing@acme.example"
},
"copies": {
"enabled": True,
"to": "a@acme.example, b@acme.example"
}
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/sending")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
from: {
email: "billing@acme.example"
},
copies: {
enabled: true,
to: "a@acme.example, b@acme.example"
}
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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"
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}