Setup

Changed on
post/v1/setup/notification-providers

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/setup/notification-providers
  • Auth: one of:
    • HTTP bearer
    • API key in cookie p93_control_access

Request body

namestring required
hoststring required
portinteger required
usernamestring
passwordstring
tls_mode'starttls' | 'implicit_tls' required
sender_emailstring email required
sender_namestring
inheritableboolean

Response

Installation SMTP provider stored

idstring uuid required
provider'smtp' required
scope'installation' | 'organization' | 'application' required
organization_idstring uuid nullable
application_idstring uuid nullable
namestring required
sender_emailstring email required
sender_namestring required
inheritableboolean required
verifiedboolean
credentials_configuredboolean
effectiveboolean
verified_atstring date-time nullable
disabled_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

  • 05b67deceeacRevision changes
    • info

      the endpoint scheme security controlBearer was added to the API

    • info

      the endpoint scheme security controlCookie was added to the API

    • info

      the endpoint scheme security operatorBearer was removed from the API

    • info

      the endpoint scheme security operatorCookie was removed from the API

    • info

      added the media type application/json for the response with the status