Skip to content

Commit f6de1f2

Browse files
authored
Postal (docs): Clarify POSTAL_API_URL value
POSTAL_API_URL should be the base URL without API paths, as Anymail appends these automatically.
1 parent 0d1aa53 commit f6de1f2

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/esps/postal.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,15 @@ nor ``ANYMAIL_POSTAL_API_KEY`` is set.
4646

4747
.. rubric:: POSTAL_API_URL
4848

49-
Required. The base url for calling the Postal API.
49+
Required. The base URL of your Postal server (without /api/v1 or any API paths).
50+
Anymail will automatically append the required API paths.
51+
52+
.. code-block:: python
53+
54+
ANYMAIL = {
55+
...
56+
"POSTAL_API_URL": "https://yourpostal.example.com",
57+
}
5058
5159
5260
.. setting:: ANYMAIL_POSTAL_WEBHOOK_KEY

0 commit comments

Comments
 (0)