Skip to main content
POST
/
v2
/
workspace
/
emailconfig
/
update
Update Email Config
curl --request POST \
  --url https://api.velt.dev/v2/workspace/emailconfig/update \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "useEmailService": true,
    "emailServiceConfig": {
      "type": "<string>",
      "apiKey": "<string>",
      "fromEmail": "<string>",
      "fromCompany": "<string>",
      "triggers": {
        "comment_annotation.add": true,
        "comment.add": true,
        "comment_annotation.status_change": true,
        "comment_annotation.assign": true,
        "comment_annotation.priority_change": true
      }
    }
  }
}
'
{
  "result": {
    "status": "success",
    "message": "Email configuration updated successfully.",
    "data": {
      "useEmailService": true,
      "emailServiceConfig": {
        "type": "sendgrid",
        "apiKey": "SG.xxxxxxxxxx",
        "fromEmail": "noreply@example.com",
        "fromCompany": "Example Corp"
      }
    }
  }
}
Use this API to update the email service configuration for a workspace. At least one of useEmailService or emailServiceConfig must be provided.
This endpoint uses API-key-level auth: pass x-velt-api-key and x-velt-auth-token as headers. You can obtain these from the Get Auth Tokens endpoint.
Defaults on first enable. If you enable the service — either with useEmailService: true or by sending emailServiceConfig.type: "custom" — and the stored config has no triggers yet (defaults are seeded even if type / SendGrid fields already exist), defaults are seeded automatically: the service is marked as a custom provider (type: "custom"), the standard comment triggers and all huddle triggers are turned on, and useEmailService is set to true. Existing non-trigger fields are preserved, and any emailServiceConfig values you send in the same request are merged on top of these defaults.
The response data echoes the latest post-write state as { useEmailService, emailServiceConfig } — the same shape returned by Get Email Config. Fields not part of your request fall back to the existing stored values.

​
Endpoint

POST https://api.velt.dev/v2/workspace/emailconfig/update

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
Params

​
data
object
required

​
Example Request

{
  "data": {
    "useEmailService": true,
    "emailServiceConfig": {
      "type": "sendgrid",
      "apiKey": "SG.xxxxxxxxxx",
      "fromEmail": "noreply@example.com",
      "fromCompany": "Example Corp"
    }
  }
}

​
Example Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Email configuration updated successfully.",
    "data": {
      "useEmailService": true,
      "emailServiceConfig": {
        "type": "sendgrid",
        "apiKey": "SG.xxxxxxxxxx",
        "fromEmail": "noreply@example.com",
        "fromCompany": "Example Corp"
      }
    }
  }
}

​
Failure Response

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "Invalid email service configuration."
  }
}

{
  "result": {
    "status": "success",
    "message": "Email configuration updated successfully.",
    "data": {
      "useEmailService": true,
      "emailServiceConfig": {
        "type": "sendgrid",
        "apiKey": "SG.xxxxxxxxxx",
        "fromEmail": "noreply@example.com",
        "fromCompany": "Example Corp"
      }
    }
  }
}