Add a Collaborator to a Project

POST

https://api.frame.io/v2/projects/:project_id/collaborators

POST

/v2/projects/:project_id/collaborators

1 import requests
2 
3 url = "https://api.frame.io/v2/projects/project_id/collaborators"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.post(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "_type": "collaborator",
3   "email": "jane.doe@example.com",
4   "project_id": "eefb57e0-79f2-4bc7-9b70-99fbc175175c",
5   "user": {
6     "digest_frequency": "weekly",
7     "image_32": "https://cdn.frame.io/images/users/32/janedoe.png",
8     "image_128": "https://cdn.frame.io/images/users/128/janedoe.png",
9     "from_google": true,
10     "mfa_enforced_at": "2023-11-15T09:30:00Z",
11     "email": "jane.doe@example.com",
12     "name": "Jane Doe",
13     "image_64": "https://cdn.frame.io/images/users/64/janedoe.png",
14     "timezone_value": "America/New_York",
15     "account_id": "acc_1234567890abcdef",
16     "updated_at": "2024-05-20T14:22:00Z",
17     "image_256": "https://cdn.frame.io/images/users/256/janedoe.png",
18     "_type": "user",
19     "user_hash": "a1b2c3d4e5f67890",
20     "upload_url": "https://uploads.frame.io/user/janedoe",
21     "profile_image": "https://cdn.frame.io/images/users/profile/janedoe.png",
22     "first_login_at": "2022-01-10T08:00:00Z",
23     "joined_via": "email_invite",
24     "id": "user_9876543210fedcba",
25     "next_digest_date": "2024-06-01T08:00:00Z",
26     "last_seen": "2024-05-25T16:45:00Z",
27     "inserted_at": "2022-01-10T08:00:00Z",
28     "from_adobe": false,
29     "avatar_color": "#4A90E2",
30     "highest_account_role": "editor",
31     "integrations": [
32       "slack",
33       "google_drive"
34     ],
35     "roles": {
36       "admin": true,
37       "id": "role_1234abcd",
38       "sales": false,
39       "support": true,
40       "service_desk": false
41     },
42     "user_default_color": "#FF5733"
43   },
44   "user_id": "user_9876543210fedcba"
45 }

Add a new Collaborator to a Project

Authentification

AuthorizationBearer

Authentification bearer de la forme Bearer <token>, où token est votre jeton d’authentification.

Paramètres de chemin

project_idstringRequisformat: "uuid"

Paramètres de requête

includestringOptionnel

Include additional “pre-loads” for this resource

Requête

Collaborator to create or update

emailstringOptionnel

Réponse

Collaborator success response

_typeenum

emailstring

project_idstringformat: "uuid"

userobject

User model

user_idstringformat: "uuid"

Erreurs

401

Unauthorized Error

404

Not Found Error