/api/v1/workspaces/{workspaceId}/messaging/inbox/attachment-uploads/initiate

Scope inbox:write

Start an upload for an outbound attachment. The response includes an upload URL. PUT the file bytes there, then complete the upload.

Pfad

workspaceIdPflicht

string

Workspace that owns the resource.

fileName

string

Name of the file.

contentType

string

Content type.

sizeBytes

integer (int64)

Size bytes.

200MessagingInboxAttachmentUploadInitiateResponseDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Messaging inbox attachment upload initiate response.

attachmentId

string (uuid)

Identifier of the attachment.

fileId

string (uuid)

Identifier of the file.

uploadSessionId

string (uuid)

Identifier of the upload session.

uploadUrl

string

URL of the upload.

uploadUrlExpiresAt

string (date-time)

When the upload url expires was recorded.

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.