Create a shared link
Regional
us.api.brault.app— follows the region selector in the top barOne call: target, access, password, expiry, anonymous comments and (for a board) the views. If a later step fails the link is deleted again and the failure is returned.
Authorization
apiKey AuthorizationBearer <token>
API key from Settings → Developers
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/shared-links" \ -H "Content-Type: application/json" \ -d '{ "target": { "type": "file", "id": "string" } }'{ "object": "shared_link", "id": "string", "url": "string", "target": { "type": "file", "id": "string" }, "access": "view", "password_protected": true, "expires_at": "2019-08-24T14:15:22Z", "expired": true, "anonymous_comments": true, "show_versions": true, "show_properties": true, "display_mode": "grid", "board_views": { "default": "gallery", "allowed": [ "gallery" ] }, "view_count": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by_id": "string"}