Invite a team member

POST

/account/members

Invite a collaborator to your account by email, reserving a seat and
emailing them an accept link. role must be admin, member, or viewer
(never owner). Subject to your plan's seat cap and to a per-account
invite-email budget (see 429). The invite token is emailed to the invitee
and is never returned in the response.

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 ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The invited collaborator (an invited seat).

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409BadRequest

🟠429Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://upload.tf/api/v1/account/members' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "teammate@example.com",
    "role": "admin"
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "member": {
            "id": "b3f1c2d4-5678-4abc-9def-0123456789ab",
            "email": "user@example.com",
            "role": "admin",
            "status": "invited",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "inviteExpiresAt": "2019-08-24T14:15:22.123Z",
            "acceptedAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "seatLockedAt": "2019-08-24T14:15:22.123Z"
        }
    }
}

Modified at 2026-08-08 15:20:28

List team members

Revoke a team member