Skip to content
Pidgely Docs

API reference · Commerce (stores)

Enable, disable or reset an order e-mail

PATCHhttps://api.pidgely.com/commerce/stores/{id}/order-emails/{kind}
View as Markdown

Enabling needs the store's sender address (422 sender_required). use_default goes back to the default design (the customized template stays in Templates).

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Store id. UUID.
kind string Yes One of order_confirmation, payment_approved, order_shipped, order_delivered, order_cancelled.

Body parameters

JSON object.

Name Type Required Description
enabled boolean No —
use_default boolean No —

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X PATCH 'https://api.pidgely.com/commerce/stores/0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21/order-emails/order_confirmation' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "enabled": false,
  "use_default": false
}'

Response

200 OK

JSON
{
  "kind": "order_confirmation",
  "enabled": false,
  "template_id": "0199d7f7-7e2f-7b5c-8a4d-1c9e3f6a0b27",
  "subject": "Hello from Acme",
  "name": "Example"
}

Response fields

Name Type Required Description
kind string Yes One of order_confirmation, payment_approved, order_shipped, order_delivered, order_cancelled.
enabled boolean Yes —
template_id string | null Yes UUID.
subject string Yes Subject line, up to 998 bytes. Required unless a template provides it.
name string Yes Display name.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.