Endpoint: /sites/{siteId}/sendPortal

Returns and updates send portal configuration for specific site

GET
PATCH

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/sendPortal

GET Body Sample

Copy

### GET Send Portal Settings####
GET https://{{host}}/admin/v2/sites/{{Siteid}}/sendPortal/ HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy

{ "data": { "id": "0de7387f-1506-427d-b997-e18bcdb8cbae", "type": 
"sendPortal", "attributes": { "enabled": true, "recipients": "UsersGuestsAnonymous", 
"allowedDomains": { "enabled": false, "list": [ "*.*" ] }, 
"deniedDomains": { "enabled": false, "list": [ "*.*" ] }, 
"reservedPath": "/send", "protocol": "https", "hostName": "172.31.223.227", "port": "443", 
"autoAttachInOutlook": { "enabled": false, "whenExceedMbytes": 10 }, 
"linkExpiration": { "value": 1, "units": "Month" }, 
"retainFilesAfterLinkExpiration": { "value": 0, "unit": "Day" }, 
"allowRepliesWithFiles": true, "sendEntireMessageSecurely": "LetUserChoose", 
"outOfBandPasscode": "Sender chooses", "secondVerification": "email", 
"fileRequestPortal": { "enabled": false, "reservedPath": "/request" } } }, 
"links": { 
"self": "admin/v2/sites/0de7387f-1506-427d-b997-e18bcdb8cbae/sendPortal" } }

GET PowerShell Sample

Copy

###GET Send Portal Configuration Details###
Write-Output "GET Send Portal Configuration Details"
Write-Output "-------------------------------------"
#$siteID = "Enter site ID"
$SendList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/sendPortal" -Method 'GET' -Headers $authHeader
Write-Output $Sendlist | ConvertTo-Json -Depth 25

Method & URL

PATCH https://[server URL]:[port]/admin/v2/sites/{siteId}/sendPortal

PATCH Body Sample

Copy

### PATCH Send Portal Settings ###
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/sendPortal/ HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "type": "sendPortal",
    "attributes": {
      "enabled": true,
      "recipients": "UsersGuestsAnonymous",
      "allowedDomains": {
        "enabled": true,
        "list": [
          "hotmail.*", "gmail.*"
        ]
      },
      "deniedDomains": {
        "enabled": true,
        "list": [
          "GSB.*"
        ]
      },
      "reservedPath": "/send",
      "protocol": "https",
      "hostName": "172.31.223.227",
      "port": "443",
      "autoAttachInOutlook": {
        "enabled": false,
        "whenExceedMbytes": 10
      },
      "linkExpiration": {
        "value": 1,
        "units": "Month"
      },
      "retainFilesAfterLinkExpiration": {
        "value": 0,
        "unit": "Day"
      },
      "allowRepliesWithFiles": true,
      "sendEntireMessageSecurely": "LetUserChoose",
      "outOfBandPasscode": "Sender chooses",
      "secondVerification": "email",
      "fileRequestPortal": {
        "enabled": false,
        "reservedPath": "/request"
      }
    }
  }
}

PATCH Response Body Sample

The response will return the same response as the GET request, however, it will now include the updated Patch request(s).

Copy

{ "data": { "id": "0de7387f-1506-427d-b997-e18bcdb8cbae", "type": 
"sendPortal", "attributes": { "enabled": true, "recipients": 
"UsersGuestsAnonymous", "allowedDomains": { "enabled": false, 
"list": [ "hotmail.*", "gmail.*" ] }, "deniedDomains": { 
"enabled": false, "list": [ "GSB.*" ] }, "reservedPath": "/send", 
"protocol": "http", "hostName": "", "port": "113", "autoAttachInOutlook": { 
"enabled": false, "whenExceedMbytes": 10 }, "linkExpiration": { "value": 1, "units": "Month" }, 
"retainFilesAfterLinkExpiration": { "value": 0, "unit": "Day" }, "allowRepliesWithFiles": true, 
"sendEntireMessageSecurely": "LetUserChoose", "outOfBandPasscode": "Sender chooses", 
"secondVerification": "email", "fileRequestPortal": { "enabled": false, "reservedPath": 
"/request" } } }, "links": { "self": 
"/admin/v2/sites/0de7387f-1506-427d-b997-e18bcdb8cbae/sendPortal" } }

PATCH PowerShell Sample

Copy

Write-Output "PATCH Send Portal Configuration Details"
Write-Output "----------------------------------------"
$update = 
'{
  "data": {
    "type": "sendPortal",
    "attributes": {
      "enabled": true,
      "recipients": "UsersGuestsAnonymous",
      "allowedDomains": {
        "enabled": true,
        "list": [
          "outlook.*", "yahoo.*"
        ]
      },
      "deniedDomains": {
        "enabled": true,
        "list": [
          "GSB.*"
        ]
      },
      "reservedPath": "/send",
      "protocol": "http",
      "hostName": "12.12.12.12",
      "port": "333",
      "autoAttachInOutlook": {
        "enabled": false,
        "whenExceedMbytes": 10
      },
      "linkExpiration": {
        "value": 1,
        "units": "Month"
      },
      "retainFilesAfterLinkExpiration": {
        "value": 1,
        "unit": "Day"
      },
      "allowRepliesWithFiles": true,
      "sendEntireMessageSecurely": "LetUserChoose",
      "outOfBandPasscode": "Sender chooses",
      "secondVerification": "email",
      "fileRequestPortal": {
        "enabled": false,
        "reservedPath": "/request"
      }
    }
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 25
$patchReturn = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/sendPortal" 
-Method 'PATCH' -Headers $authHeader -Body $update