Create a site for a subject

POST

/subjects/{subject}/sites

Creates a hosted site (kind site) for this one subject, from
EITHER a multipart/form-data body with a file field (a .zip)
OR an application/json body — see this document's top-level
"Hosted sites" section. Runs through the same content-screening and
plan-cap gates as any other hosted-site upload.

A subject TOKEN may never set name (or a multipart name field):
refused with 400. A platform KEY may.

Requires a declared Content-Length header — refused with 411 if
absent, stricter than the rest of this API (see LengthRequired).

Refused with 403 if the subject is not in good standing (see
Forbidden).

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params

application/json

Required

Examples

Responses

🟢201Created

application/json

The site was created.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠411

🟠413

🟠429

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://upload.tf/api/v1/subjects/ext:end-user-42/sites' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "files": [
        {
            "path": "string",
            "contentBase64": "string"
        }
    ]
}'

Response Example

201 - Example 1

{
    "success": true,
    "data": {
        "site": {
            "id": "string",
            "name": "string",
            "url": "string",
            "fileName": "string",
            "kind": "site",
            "sizeBytes": 0,
            "fileCount": 0,
            "createdAt": "2019-08-24T14:15:22.123Z",
            "expiresAt": "2019-08-24T14:15:22.123Z",
            "chatEnabled": true,
            "subjectId": "68460e63-0717-47f9-8fd8-d28f152cb30b"
        }
    }
}

Modified at 2026-08-18 09:08:48

List a subject's sites

Get a site