PATCH
/
organizations
/
update-email-for-notification
curl --request PATCH \
  --url https://scribe-api.puppilot.co/organizations/update-email-for-notification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '{
  "email": "<string>"
}'
{
  "message": "Organization's email notification settings updated successfully.",
  "data": {
    "public_id": "<string>",
    "name": "Organization Name",
    "description": "Organization Description",
    "has_slack_bot_token": true,
    "slack_channel": null,
    "email_notification": null,
    "is_active": false
  }
}

Overview

Use this endpoint to specify an email address that will receive notifications in the event of API errors or other important updates related to your organization. Once configured, any future error notifications will automatically be sent to the provided email address.

Example Request

{
  "email": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
string
required

API versioning is required. Include the header X-API-Version with current version value in all requests.

Example:

"v1"

Body

application/json
email
string
required

The email address to be used for notifications.

Response

200 - application/json
Organization's email notification settings updated successfully.
message
string
Example:

"Organization's email notification settings updated successfully."

data
object