POSTapi.synup.com/api/v4/users/add_user_and_folder
Add User and folder
This api is a combination of add_user and create_folder and assign_folder_to_user APIs. The API will take in all parameters of add_user API and create_folder APIs. Operations to be done are create user, create folder and assign folder to user.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Body
| Name | Type | Required | Description |
|---|---|---|---|
input | object | required | |
input.roleId | string | required | |
input.firstName | string | required | |
input.lastName | string | required | |
input.email | string | required | |
input.directCustomer | boolean | required | |
input.locale | string | required | |
input.locationIds | array of string | required | |
input.socialProfileIds | array of string | required | |
input.name | string | required | |
input.userId | string | required | Base64 encoded user ID |
input.isDefaultFolder | boolean | required |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/users/add_user_and_folder' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"input": {
"roleId": "Q3VzdG9tUm9sZToyMDgzMQ==",
"firstName": "testing ",
"lastName": "user",
"email": "sandeep.kota+918673997@synup.com",
"directCustomer": true,
"locale": "ENGLISH",
"locationIds": [
"TG9jYXRpb246ODcxMjE="
],
"socialProfileIds": [],
"name": "sandybroskis19",
"isDefaultFolder": true
}
}'const res = await fetch('https://api.synup.com/api/v4/users/add_user_and_folder', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"input": {
"roleId": "Q3VzdG9tUm9sZToyMDgzMQ==",
"firstName": "testing ",
"lastName": "user",
"email": "sandeep.kota+918673997@synup.com",
"directCustomer": true,
"locale": "ENGLISH",
"locationIds": [
"TG9jYXRpb246ODcxMjE="
],
"socialProfileIds": [],
"name": "sandybroskis19",
"isDefaultFolder": true
}
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/users/add_user_and_folder",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"input": {
"roleId": "Q3VzdG9tUm9sZToyMDgzMQ==",
"firstName": "testing ",
"lastName": "user",
"email": "sandeep.kota+918673997@synup.com",
"directCustomer": True,
"locale": "ENGLISH",
"locationIds": [
"TG9jYXRpb246ODcxMjE="
],
"socialProfileIds": [],
"name": "sandybroskis19",
"isDefaultFolder": True
}
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/users/add_user_and_folder", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successfully added folders to user |
Example response (generated from the schema)
{
"data": {
"addUserAndFolder": {
"success": true,
"assignFolder": true,
"user": {
"firstName": "string",
"lastName": "string",
"email": "string",
"directCustomer": true,
"databaseId": 0
},
"folder": {
"id": "string",
"name": "string",
"locationCount": null
},
"errors": [
"string"
]
},
"addFoldersForUser": {
"status": [
{
"errors": [
"string"
],
"folderId": "00000000-0000-0000-0000-000000000000",
"success": true
}
]
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.addUserAndFolder | object | required | |
data.addUserAndFolder.success | boolean | required | |
data.addUserAndFolder.assignFolder | boolean | required | |
data.addUserAndFolder.user | object | required | |
data.addUserAndFolder.user.firstName | string | required | |
data.addUserAndFolder.user.lastName | string | required | |
data.addUserAndFolder.user.email | string | required | |
data.addUserAndFolder.user.directCustomer | boolean | required | |
data.addUserAndFolder.user.databaseId | integer | required | |
data.addUserAndFolder.folder | object | required | |
data.addUserAndFolder.folder.id | string | required | |
data.addUserAndFolder.folder.name | string | required | |
data.addUserAndFolder.folder.locationCount | null | required | |
data.addUserAndFolder.errors | array of string | required | |
data.addFoldersForUser | object | optional | |
data.addFoldersForUser.status | array of object | optional | |
data.addFoldersForUser.status[].errors | array of string | optional | |
data.addFoldersForUser.status[].folderId | string | optional | |
data.addFoldersForUser.status[].success | boolean | optional |