Create an app integration SMTP

Creates a new app integration SMTP.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The request data transfer object for the SMTP integration.

appIntegrationIdstring · min: 1Required

The type of the SMTP integration.

namestring · min: 1Required

The name of the SMTP integration.

hoststring · min: 1Required

The host of the SMTP integration.

portinteger · int32Required

The port of the SMTP integration.

usernamestring · min: 1Required

The username of the SMTP integration.

passwordstring · min: 1Required

The password of the SMTP integration.

useTlsboolean | nullableOptional

Flag to indicate if the SMTP integration uses TLS. By default, it is set to false.

isDefaultboolean | nullableOptional

Flag to indicate if the SMTP integration is the default. By default, it is set to false.

descriptionstring | nullableOptional

The description of the SMTP integration.

statusstring · enumOptionalPossible values:

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/smtp HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "appIntegrationId": "text",
  "name": "text",
  "host": "text",
  "port": 1,
  "username": "text",
  "password": "text",
  "useTls": true,
  "isDefault": true,
  "description": "text",
  "status": "0 - Inactive"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "name": "SMTP Integration",
    "host": "smtp.gmail.com",
    "port": 587,
    "username": "username",
    "password": "password",
    "useTls": true,
    "isDefault": true,
    "description": "SMTP Integration Description",
    "status": "Active",
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}