Users
Invite users with roles and access
POST
/
users
/
invite
/
bulk-detailed
Invite many fully-specified users at once (per-user name, role, and project access). Used by the v2 -> v3 migration to provision users in one round-trip while preserving each source user’s name and scope.
curl --request POST \
--url https://backend.branch.flowengineering.com/users/invite/bulk-detailed \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>' \
--data '
{
"customer": "<string>",
"users": [
{
"email": "<string>",
"all_projects": true,
"family_name": "<string>",
"given_name": "<string>",
"project_ids": [
"<string>"
],
"role": "editor"
}
],
"suppress_notification": false
}
'import requests
url = "https://backend.branch.flowengineering.com/users/invite/bulk-detailed"
payload = {
"customer": "<string>",
"users": [
{
"email": "<string>",
"all_projects": True,
"family_name": "<string>",
"given_name": "<string>",
"project_ids": ["<string>"],
"role": "editor"
}
],
"suppress_notification": False
}
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
customer: '<customer>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer: '<string>',
users: [
{
email: '<string>',
all_projects: true,
family_name: '<string>',
given_name: '<string>',
project_ids: ['<string>'],
role: 'editor'
}
],
suppress_notification: false
})
};
fetch('https://backend.branch.flowengineering.com/users/invite/bulk-detailed', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"failed": [
{
"email": "<string>",
"message": "<string>"
}
],
"invited": [
"<string>"
]
}Authorizations
api-keybearer
Headers
Workspace identifier
Body
application/json
⌘I
Invite many fully-specified users at once (per-user name, role, and project access). Used by the v2 -> v3 migration to provision users in one round-trip while preserving each source user’s name and scope.
curl --request POST \
--url https://backend.branch.flowengineering.com/users/invite/bulk-detailed \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'customer: <customer>' \
--data '
{
"customer": "<string>",
"users": [
{
"email": "<string>",
"all_projects": true,
"family_name": "<string>",
"given_name": "<string>",
"project_ids": [
"<string>"
],
"role": "editor"
}
],
"suppress_notification": false
}
'import requests
url = "https://backend.branch.flowengineering.com/users/invite/bulk-detailed"
payload = {
"customer": "<string>",
"users": [
{
"email": "<string>",
"all_projects": True,
"family_name": "<string>",
"given_name": "<string>",
"project_ids": ["<string>"],
"role": "editor"
}
],
"suppress_notification": False
}
headers = {
"customer": "<customer>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
customer: '<customer>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer: '<string>',
users: [
{
email: '<string>',
all_projects: true,
family_name: '<string>',
given_name: '<string>',
project_ids: ['<string>'],
role: 'editor'
}
],
suppress_notification: false
})
};
fetch('https://backend.branch.flowengineering.com/users/invite/bulk-detailed', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"failed": [
{
"email": "<string>",
"message": "<string>"
}
],
"invited": [
"<string>"
]
}