Update an app integration SMTP

Updates the app integration SMTP by the given id.

put

Path parameters

idstringRequired

The id of the app integration SMTP.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

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 · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

• Inactive - In case of JFW object's status being inactive.
• Active - In case of JFW object's status being active

Possible values:

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

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

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/app-integrations/smtp/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/app-integrations/smtp/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 172

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

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "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": []
}