Appearance
Create User Document
Attach a document record to a user profile. Requires ADMIN or MANAGE_PEOPLE permissions and the PEOPLE_MANAGEMENT feature flag.
Parameters
| name * are required parameters | data type | description |
|---|---|---|
userId* | string | The unique identifier of the user |
body.name* | string | The display name of the document |
body.url* | string | The storage URL of the document |
body.type | string | The MIME type or document category |
body.private | boolean | Whether the document is private (visible only to admins) |
Return Value
The created document record attached to the user.
Error Codes
400 Bad Request: Returned when parameters are invalid.401 Unauthorized: Returned when permissions are insufficient.
Examples
bash
curl -X POST "https://app.wombat.software/api/{targetPath}/user/:userId/document" \
-H "Content-Type: application/json" \
-H "Authentication: Bearer ..." \
-d '{"name": "Employment Contract", "url": "gs://bucket/path/file.pdf"}'ENDPOINTS
post
/api/{targetPath}/user/:userId/document