uploads attachment to s3 and returns media preview url

uploads attachment to s3 and returns media preview url

Path Parameters

departmentUUID string required

application/json

Request Body required

docFileName string
fileExtension string
mimeType string
originalFileName string
docSize string
thumbnailFileName string
mediaPreviewURL string
messageUuid string

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

mediaPreviewURL string
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "mediaPreviewURL": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /department/:departmentUUID/attachment/preview/url/generate

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

Body required

{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}

curl / cURL

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

python / requests

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

go / native

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

nodejs / axios

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

csharp / RestSharp

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

php / cURL

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

java / OkHttp

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'

powershell / RestMethod

curl -L -X POST '/communications/department/:departmentUUID/attachment/preview/url/generate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "docFileName": "string",
  "fileExtension": "string",
  "mimeType": "string",
  "originalFileName": "string",
  "docSize": "string",
  "thumbnailFileName": "string",
  "mediaPreviewURL": "string",
  "messageUuid": "string"
}'