Skip to content
Coritan Docs

Change organization settings

Change your organization's name, billing mode, branding, legal details and invoicing, and choose how its email leaves.

View as Markdown

The Settings tab holds everything that describes your organization: the name customers see, how they pay, your storefront's branding, the legal details printed on invoices and statements, how invoices are made, and how your email reaches customers. Each card saves on its own.

You need the owner or admin role in the organization. Other members see a note that their role cannot open the tab.

Change the name and billing mode

Section titled Change the name and billing mode
  1. Go to Organizations, open your organization and choose Settings.
  2. On the Organization card, change the Name. It must be at least two characters.
  3. Choose the Billing mode: Platform merchant of record, Own gateway or Hybrid. Organization billing explains each one; the own gateway modes need a PayNow store.
  4. Choose Save changes, or Discard to put the card back as it was.

The card also shows what Coritan sets for you: the slug, the tier, the platform fee and your limits. Contact support to change them.

Section titled Change the branding and legal details

Each of these cards has its own Save changes button, and the footer counts the changes you have not saved.

Storefront & branding
The Custom domain for your storefront, the Logo URL and Favicon URL, the Primary colour and Secondary colour as hex codes such as #0F2A57, the Support email, and the Terms of service URL and Privacy policy URL. Your storefront reads these through the Storefront API.
Legal entity
The Trading name, Legal name, Registration number, Tax / VAT ID, the two-letter Country code, the Billing email and the Registered address. Invoice PDFs name the legal name (or the trading name when there is none), the registered address and the tax ID. Statements need the registered address.
Invoicing
The Invoice prefix that starts every invoice number, the Currency of new invoices, the Tax rate added to order and renewal invoices (0–100%), the Payment terms in days (0–365), and an Invoice footer for bank details or legal notes. Payment terms also decide how early we invoice a renewal: a service is invoiced once its next due date is that many days away. The Timezone field is saved, but statements use UTC.
Outgoing email (SMTP)
The SMTP account your customer emails go out through: SMTP host, Port, Username, Password, From address and From name. We store the password encrypted and never show it again; leave the field empty to keep it. With no SMTP host, we send your email through Coritan's own SMTP service.

Emails to your customers and staff link to pages on the Custom domain: invoices, password resets, email verification and sign-in. With no custom domain, those links go to Coritan's own site. Saving a domain does not point it at your storefront, and the card shows Domain unverified until Coritan verifies it. Contact support after you save one. Customer sign-in lists the pages your storefront needs for those links.

Invoices, receipts, password resets and ticket replies to your customers leave through the transport on the Outbound transport card:

Transport What happens
SMTP only Mail goes through the SMTP account above, or through Coritan's SMTP service when its host is blank.
In-house, SMTP as fallback An SMTP Relay tenant sends it, and SMTP takes over while that tenant is not ready.
In-house only An SMTP Relay tenant sends it with no fallback, so mail fails while the tenant is not ready.

For the two in-house transports, fill in:

  • Mail tenant: the name of the SMTP Relay tenant that carries your mail. It must be one of your organization's relay tenants. The dashboard does not show tenant names, so ask support for it.
  • Sending domain: the envelope sender domain, such as send.example.com. It must be a domain on that tenant.
  • Envelope local part: the part before the @ that bounces return to. It defaults to noreply.
  • Visible From: Your From address keeps the From address as you set it; The sending subdomain puts From on the sending domain and your address in Reply-To.

Choose Save changes. The card then shows the Effective route your mail takes right now and, for the in-house transports, whether the tenant, its sending domain, its DKIM record and its relay credential are ready.

The Features & mail presentation card below it lists the features Coritan has turned on for your organization and the host names your mail customers see. It is read only; ask support to change it.

Your storefront, invoices and emails use the new details from the next page load, invoice or message.

mail tenant ... does not exist or ... is not a relay tenant
Check the Mail tenant name with support. It must be an SMTP Relay tenant, not a Mail Hosting one.
... is not a domain on mail tenant ...
Add the sending domain to the relay tenant and verify it first. See Add a sending domain to SMTP Relay.
The card says the in-house route is not ready
Read the reason on the card. Usually the sending domain's records have not verified yet. With In-house, SMTP as fallback, mail keeps flowing through SMTP meanwhile.

The changes need an owner's or admin's access token, sent as Authorization: Bearer $CORITAN_TOKEN. Any member can read the settings.

PATCH /api/v1/orgs/{org_slug} changes the organization itself: name (2–255 characters) and billing_mode (platform_mor, own_gateway or hybrid).

GET /api/v1/orgs/{org_slug}/settings reads the settings, and PATCH on the same path changes only the fields you send:

Card Fields
Storefront & branding custom_domain, logo_url, favicon_url, primary_color, secondary_color, support_email, terms_url, privacy_url
Legal entity company_name (the trading name), legal_name, registration_number, tax_id, country_code, billing_email, registered_address
Invoicing invoice_prefix, default_currency, tax_rate, payment_terms_days, invoice_footer, timezone
Outgoing email smtp_host, smtp_port, smtp_user, smtp_pass, smtp_from_email, smtp_from_name
Outbound transport mail_outbound: an object with transport (smtp, auto or inhouse), tenant, envelope_domain, envelope_local and from_mode (apex or subdomain)

The answer leaves out smtp_pass, and carries custom_domain_verified and the read-only features. Send null to clear a field, except primary_color, secondary_color, invoice_prefix, default_currency, tax_rate, payment_terms_days, timezone and smtp_port, which always need a value.

Shell
curl -X PATCH "https://api.coritan.com/api/v1/orgs/acme/settings" \
  -H "Authorization: Bearer $CORITAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"support_email": "help@example.com", "invoice_prefix": "ACME-", "payment_terms_days": 14}'

The dashboard checks each value before it saves; the API stores what you send, so check currencies, rates and colours yourself.

GET /api/v1/orgs/{org_slug}/settings/mail-outbound answers the saved transport with effective, the route mail takes now (such as own SMTP, platform SMTP or in-house), smtp_configured, and an inhouse object with ready and a reason when it is not.

API operations on this page

MethodPathWhat it does
PATCH/api/v1/orgs/{org_slug}Update organization
GET/api/v1/orgs/{org_slug}/settingsGet org settings
PATCH/api/v1/orgs/{org_slug}/settingsUpdate org settings
GET/api/v1/orgs/{org_slug}/settings/mail-outboundThe outbound transport block plus whether the in-house side can send now