Updates a shared project and optionally invites or adds external users

Updates a shared project and optionally invites or adds external users

Path Parameters

projectId string required

Project ID

application/json

Request Body required

Share details together with sub account and/or regular users that will be added or invited to a shared project

regularUsers object[] nullable
Array [
email string nullable
]
shareDetails object
accessMode string nullable
invitedUsersCanShareInternally boolean nullable
shareFunctionalities object nullable
analysisActions object nullable
createQuestions boolean nullable
createWeightSet boolean nullable
exportToExcel boolean nullable
exportToPpt boolean nullable
exportToWord boolean nullable
analysisTypes object nullable
chart boolean nullable
crossTable boolean nullable
data boolean nullable
dig boolean nullable
qTable boolean nullable
report boolean nullable
script boolean nullable
topline boolean nullable
sharedById string nullable
sharedByMessage string nullable
sharedByName string nullable
sharedDateUtc date-time nullable
subAccountUsers object[] nullable
Array [
email string nullable
id string nullable
subAccountId string nullable
]

Responses

• 200
• 400
• 401
• 403
• 404

---

Shared project successfully updated

Invalid request. The message will vary depending on the cause

Unauthorized

Forbidden

Project not found

PATCH /share/:projectId/external-users

Request

Base URL

https://api.walr.com

projectId — path required

Body required

{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}

curl / cURL

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

python / requests

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

go / native

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

nodejs / axios

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

ruby / Net::HTTP

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

csharp / RestSharp

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

php / cURL

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

java / OkHttp

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'

powershell / RestMethod

curl -L -X PATCH 'https://api.walr.com/share/:projectId/external-users' \
-H 'Content-Type: application/json' \
--data-raw '{
  "regularUsers": [
    {
      "email": "string"
    }
  ],
  "shareDetails": {
    "accessMode": "string",
    "invitedUsersCanShareInternally": true,
    "shareFunctionalities": {
      "analysisActions": {
        "createQuestions": true,
        "createWeightSet": true,
        "exportToExcel": true,
        "exportToPpt": true,
        "exportToWord": true
      },
      "analysisTypes": {
        "chart": true,
        "crossTable": true,
        "data": true,
        "dig": true,
        "qTable": true,
        "report": true,
        "script": true,
        "topline": true
      }
    },
    "sharedById": "string",
    "sharedByMessage": "string",
    "sharedByName": "string",
    "sharedDateUtc": "2025-01-13T15:06:26.901Z"
  },
  "subAccountUsers": [
    {
      "email": "string",
      "id": "string",
      "subAccountId": "string"
    }
  ]
}'