Zum Inhalt springen
Leadtime
Deutsch
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Disable helpdesk for email account

Disables helpdesk functionality for a specific email account. Any account-level override settings are preserved but not applied until re-enabled.

What this does:

  • Disables helpdesk processing for the specified email account
  • Stops automatic email pulling and task creation for this account
  • Preserves all account-specific settings for future re-enabling
  • The account settings remain in the database but are not used

How it works:

  1. The system verifies the email account exists and belongs to the workspace
  2. Sets isEnabled: false for the account’s helpdesk settings
  3. All account-level overrides are preserved (task defaults, auto-reply, etc.)
  4. The account is removed from automated email pulling cron jobs

After disabling:

  • No new emails will be pulled from this account
  • No tasks will be created from emails sent to this account
  • Existing tasks and email history remain unchanged
  • Settings can be restored by re-enabling the account

Use cases:

  • Temporarily disable helpdesk for an account (e.g., during maintenance)
  • Stop processing emails for a specific account without losing configuration
  • Test different configurations by disabling/enabling accounts

Error handling: Returns 404 if the email account is not found or doesn’t belong to the workspace.

Note: This endpoint requires the WsSettings.manageSettings permission.

DELETE/helpdesk/email-accounts/{accountId}/disable
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
accountIdstringrequired

Email account ID

Responses
200

Helpdesk disabled for email account successfully

displayNamestringrequired

Display name for the email account. This is the friendly name shown in the UI and in email headers.

emailstringrequired

Email address of the account. This is the address that receives helpdesk emails.

helpdeskEnabledbooleanrequired

Whether helpdesk is currently enabled for this email account. When enabled, emails sent to this account will be automatically processed and converted to tasks. When disabled, emails are ignored.

idstringrequired

Unique identifier for the email account. Use this ID to reference the account in other API calls.

settingsobject

Account-specific helpdesk settings that override workspace defaults. Only present when helpdesk is enabled for this account. Null fields inherit from workspace defaults. If helpdesk is disabled, this field will be undefined.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

Email account not found

Try it
Server
Authorization
Parameters
Request
curl -X DELETE "https://leadtime.app/api/public/helpdesk/email-accounts/account-uuid-123/disable" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "displayName": "Support Team",
  "email": "support@example.com",
  "helpdeskEnabled": true,
  "id": "account-uuid-123",
  "settings": {
    "defaultReplyBody": "<p>Thank you for contacting us.</p>",
    "emailAccountId": "account-uuid-123",
    "emailAddress": "support@example.com",
    "emailDisplayName": "Support Team",
    "isEnabled": true,
    "sendDefaultReply": true,
    "taskAccountableId": null,
    "taskAssignedId": null,
    "taskPriority": "Normal",
    "taskProjectId": null,
    "taskStatusId": null,
    "taskTagsIds": null,
    "taskTypeId": "type-uuid-456"
  }
}