Add a Collaborator to a Project | Frame.io API Documentation

import requests
url = "https://api.frame.io/v2/projects/project_id/collaborators"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "_type": "collaborator",
  "email": "jane.doe@example.com",
  "project_id": "eefb57e0-79f2-4bc7-9b70-99fbc175175c",
  "user": {
    "digest_frequency": "weekly",
    "image_32": "https://cdn.frame.io/images/users/32/janedoe.png",
    "image_128": "https://cdn.frame.io/images/users/128/janedoe.png",
    "from_google": true,
    "mfa_enforced_at": "2023-11-15T09:30:00Z",
    "email": "jane.doe@example.com",
    "name": "Jane Doe",
    "image_64": "https://cdn.frame.io/images/users/64/janedoe.png",
    "timezone_value": "America/New_York",
    "account_id": "acc_1234567890abcdef",
    "updated_at": "2024-05-20T14:22:00Z",
    "image_256": "https://cdn.frame.io/images/users/256/janedoe.png",
    "_type": "user",
    "user_hash": "a1b2c3d4e5f67890",
    "upload_url": "https://uploads.frame.io/user/janedoe",
    "profile_image": "https://cdn.frame.io/images/users/profile/janedoe.png",
    "first_login_at": "2022-01-10T08:00:00Z",
    "joined_via": "email_invite",
    "id": "user_9876543210fedcba",
    "next_digest_date": "2024-06-01T08:00:00Z",
    "last_seen": "2024-05-25T16:45:00Z",
    "inserted_at": "2022-01-10T08:00:00Z",
    "from_adobe": false,
    "avatar_color": "#4A90E2",
    "highest_account_role": "editor",
    "integrations": [
      "slack",
      "google_drive"
    ],
    "roles": {
      "admin": true,
      "id": "role_1234abcd",
      "sales": false,
      "support": true,
      "service_desk": false
    },
    "user_default_color": "#FF5733"
  },
  "user_id": "user_9876543210fedcba"
}

Add a new Collaborator to a Project

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequiredformat: "uuid"

Query parameters

includestringOptional

Include additional “pre-loads” for this resource

Request

Collaborator to create or update

emailstringOptional

Response

Collaborator success response

_typeenum

Allowed values:

emailstring

project_idstringformat: "uuid"

userobject

User model

user_idstringformat: "uuid"

Errors

401

Unauthorized Error

404

Not Found Error