Explore documentation
  1. Create outgoing e-mail
  2. Get outgoing e-mail
  3. List outgoing e-mails
  4. Remove outgoing e-mail
  5. Response attributes
  6. Update outgoing e-mail

Update outgoing e-mail

Updates an existing outgoing e-mail integration. Only the parameters you send are changed. Returns the updated integration, or validation errors.

Sending recipients replaces the whole recipient list.

PATCH https://incidents.betterstack.com/api/v2/outgoing-emails/{integration_id}

URL parameters

integration_id
required string

The ID of the outgoing e-mail integration.

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
string

application/json

Body parameters

name
string

The name of the outgoing e-mail integration that you can see in the dashboard.

recipients
array

The addresses that receive incident e-mails. Each entry is either a plain e-mail string, or an object with an email key plus your own custom attribute keys. Replaces the whole recipient list when sent. See Create outgoing e-mail for the full shape.

on_incident_started
boolean

Whether to send an e-mail when an incident starts.

on_incident_acknowledged
boolean

Whether to send an e-mail when an incident is acknowledged.

on_incident_resolved
boolean

Whether to send an e-mail when an incident is resolved.

on_incident_reopened
boolean

Whether to send an e-mail when an incident is reopened.

on_incident_comment
boolean

Whether to send an e-mail when a new comment is added to an incident. At least one of the on_incident_* triggers must stay enabled.

notify_alongside_primary_responder
boolean

Whether to notify recipients alongside the primary responder when no escalation policy is configured.

templates
array

Per-event message templates. See Create outgoing e-mail for the shape, variables, and replace semantics.

200

Returns the updated outgoing e-mail integration

Response body

{
  "data": {
    "id": "42",
    "type": "outgoing_email",
    "attributes": {
      "name": "Renamed client list",
      "recipients": [
        {
          "email": "new@client.com"
        }
      ],
      "team_name": "My team",
      "paused": false,
      "notify_alongside_primary_responder": true,
      "on_incident_started": true,
      "on_incident_acknowledged": true,
      "on_incident_resolved": true,
      "on_incident_reopened": true,
      "on_incident_comment": true,
      "templates": [
        {
          "incident_stage": "resolved",
          "subject": "Resolved: $NAME",
          "title": null,
          "body": null
        }
      ]
    }
  }
}
422

Returns validation errors, for example no recipients or no trigger enabled

Response body

{
  "errors": {
    "base": [
      "At least one trigger is required"
    ]
  }
}

Example cURL

Example
curl -X "PATCH" "https://incidents.betterstack.com/api/v2/outgoing-emails/42" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "name": "Renamed client list",
  "recipients": [ "new@client.com" ],
  "templates": [
    { "incident_stage": "resolved", "subject": "Resolved: $NAME" }
  ]
}'


Previous article

Response attributes