Batch create Collaborators and PendingCollaborators within a Project

import requests
url = "https://api.frame.io/v2/batch/projects/project_id/collaborators"
payload = {
    "batch": [{
            "message": "Please review this!",
            "user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        }, { "user_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" }, { "user_group_id": "cccccccc-cccc-cccc-cccc-cccccccccccc" }, { "email": "testing@foobar.biz" }],
    "default_message": "Welcome!"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "error": {
    "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa": "Something went wrong!"
  }
}

Submit a list of Collaborators to add to the given Project as Collaborators

Authentication

AuthorizationBearer

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

Path parameters

project_idstringRequiredformat: "uuid"

Request

An array of batch operations

batchlist of objectsOptional

default_messagestringOptional

Default invite message to be applied to all invites created

send_emailbooleanOptionalDefaults to true

When false no emails will be sent to the new Reviewers and Pending Reviewers

Response

Batch create success response

errorobject

Errors

401

Unauthorized Error

404

Not Found Error

1	import requests
2
3	url = "https://api.frame.io/v2/batch/projects/project_id/collaborators"
4
5	payload = {
6	"batch": [{
7	"message": "Please review this!",
8	"user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
9	}, { "user_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" }, { "user_group_id": "cccccccc-cccc-cccc-cccc-cccccccccccc" }, { "email": "testing@foobar.biz" }],
10	"default_message": "Welcome!"
11	}
12	headers = {
13	"Authorization": "Bearer <token>",
14	"Content-Type": "application/json"
15	}
16
17	response = requests.post(url, json=payload, headers=headers)
18
19	print(response.json())

1	{
2	"error": {
3	"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa": "Something went wrong!"
4	}
5	}