Skip to content
SynupAPI
Get an API key
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

NameTypeRequiredDescription
inputobjectrequired
input.roleIdstringrequired
input.firstNamestringrequired
input.lastNamestringrequired
input.emailstringrequired
input.directCustomerbooleanrequired
input.localestringrequired
input.locationIdsarray of stringrequired
input.socialProfileIdsarray of stringrequired
input.namestringrequired
input.userIdstringrequiredBase64 encoded user ID
input.isDefaultFolderbooleanrequired

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
  }
}'

Responses

StatusDescription
200Successfully 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

NameTypeRequiredDescription
dataobjectrequired
data.addUserAndFolderobjectrequired
data.addUserAndFolder.successbooleanrequired
data.addUserAndFolder.assignFolderbooleanrequired
data.addUserAndFolder.userobjectrequired
data.addUserAndFolder.user.firstNamestringrequired
data.addUserAndFolder.user.lastNamestringrequired
data.addUserAndFolder.user.emailstringrequired
data.addUserAndFolder.user.directCustomerbooleanrequired
data.addUserAndFolder.user.databaseIdintegerrequired
data.addUserAndFolder.folderobjectrequired
data.addUserAndFolder.folder.idstringrequired
data.addUserAndFolder.folder.namestringrequired
data.addUserAndFolder.folder.locationCountnullrequired
data.addUserAndFolder.errorsarray of stringrequired
data.addFoldersForUserobjectoptional
data.addFoldersForUser.statusarray of objectoptional
data.addFoldersForUser.status[].errorsarray of stringoptional
data.addFoldersForUser.status[].folderIdstringoptional
data.addFoldersForUser.status[].successbooleanoptional