Enable helpdesk for email account

Enables helpdesk functionality for a specific email account. The account will use workspace default settings unless account-level overrides are configured.

What this does:

Enables helpdesk processing for the specified email account
The account will start receiving and processing emails automatically
Uses workspace default settings if no account-specific overrides exist
Preserves any existing account-level settings if they were previously configured

How it works:

The system verifies the email account exists and belongs to the workspace
Sets isEnabled: true for the account’s helpdesk settings
If no account settings exist, they are created with workspace defaults
If account settings exist, only the isEnabled flag is updated
The account becomes eligible for automated email pulling via cron jobs

After enabling:

Emails sent to this account will be automatically pulled (every minute via cron)
Incoming emails will be converted to tasks using workspace defaults (or account overrides)
Auto-replies will be sent if configured in workspace or account settings
Tasks will be created with proper assignment, priority, and categorization

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. Workspace helpdesk must be enabled (isHelpdeskEnabled: true) for this to work.

POST/helpdesk/email-accounts/{accountId}/enable

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

accountIdstringrequired

Email account ID

Query parameters

fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull

Header parameters

LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full

Responses

200

Helpdesk enabled 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

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

accountIdpath*Email account IDfieldsToReturnqueryComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.responseShapequeryAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.LT-Response-ShapeheaderAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Request

curl -X POST "https://leadtime.app/api/public/helpdesk/email-accounts/account-uuid-123/enable" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/helpdesk/email-accounts/account-uuid-123/enable", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/helpdesk/email-accounts/account-uuid-123/enable",
    headers={
        "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"
  }
}