Skip to content
Sign inGet startedDashboard

ConceptsOrganization settings

Organization settings

The same settings as General and AI in the dashboard: the time zone Shipmail uses when a request names none, whether AI features are on, and, read-only, whether automatic sending is.

Last updated

Permissions

  • Reads need organization:read. Changes need organization:write.
  • A change acts for the person who created the API key or approved the connection. That person must be an Owner or Admin, or the request answers 403.
  • A key limited to particular mailboxes, domains or audiences cannot change them. Every change is recorded in the audit log.

Default time zone

GET/v1/organization
PATCH/v1/organization

PATCH takes default_timezone, an IANA zone or null to clear it. Both return the organization.

{
  "object": "organization",
  "id": "org_abc123",
  "name": "Acme",
  "default_timezone": "Europe/Paris"
}
FieldTypeDescription
idstringThe organization's ID.
namestringThe organization's name.
default_timezonestring | nullIANA time zone, such as Europe/Paris, used when a request names no zone. null means Etc/UTC.

When a request names no zone, calendar availability and a timed event create use the calendar time zone of the person behind the credential, then the organization's default_timezone, then Etc/UTC.

AI settings

GET/v1/organization/ai-settings
PATCH/v1/organization/ai-settings

PATCH takes models_enabled. automatic_send_enabled is read-only: a request that includes it is refused with a 422 validation error. Both return the settings.

{
  "object": "organization_ai_settings",
  "models_enabled": true,
  "automatic_send_enabled": true,
  "effective": { "models_enabled": true, "automatic_send_enabled": false }
}
FieldTypeDescription
models_enabledbooleanThe organization's switch for AI features.
automatic_send_enabledbooleanRead-only. Whether automations may send AI-drafted replies without review. Off, they save a draft instead.
effective.models_enabledbooleanWhether AI features are in effect now. Shipmail can hold them off for every organization.
effective.automatic_send_enabledbooleanWhether automatic sending is in effect now.

GET /v1/capabilities reports the default time zone and the effective switches under organization, for any key.

MCP tools

shipmail_get_organization, shipmail_update_organization, shipmail_get_organization_ai_settings and shipmail_update_organization_ai_settings, in the Organization settings permission group.

Examples

curl -X PATCH https://shipmail.to/api/v1/organization \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"default_timezone": "Europe/Paris"}'