Admin APIs
email-notifications

Update Email Notification

put/api/v1/admin/email-notifications/{notification_id}

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/email-notifications/{notification_id}
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

notification_idstring uuid required

Request body

subjectstring nullable
preview_textstring nullable
bodystring nullable
scheduled_forstring date-time nullable

Response

Successful Response

idstring uuid required
subjectstring required
preview_textstring nullable required
bodystring required
from_namestring required
from_addressstring required
status'draft' | 'sending' | 'sent' | 'failed' required
recipient_countinteger nullable required
sent_countinteger nullable required
failed_countinteger nullable required
scheduled_forstring date-time nullable required
sent_atstring date-time nullable required
created_bystring nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 4 revisions of this API.