Share an asset with users | Athena

Share an asset with specific users by email. Only users who have edit access to the asset can share it. You can share with individual users (granting ‘view’ or ‘edit’ permission). Sharing with a user who does not have an account will result in an error for that recipient, but other recipients will still be processed.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

asset_idstringRequired

Request

This endpoint expects an object.

recipientslist of objectsRequired

List of users to share the asset with. Each entry specifies an email address and the permission level to grant.

include_folder_contentsboolean or nullOptional

Controls child-sharing when sharing a container asset (folder, collection, or project). true: also share the container’s children owned by the current user. false: container only, skip children. null (default): folders share all accessible children; collections and projects are container-only (their cascade is opt-in via true).

messagestring or nullOptional<=2000 characters

Optional personal message to include in the notification email (max 2000 characters)

notifybooleanOptionalDefaults to true

Whether to send email notifications to recipients

Response

Asset sharing processed successfully

asset_idstring

ID of the shared asset

recipients_resultlist of objects

Results for each recipient that was shared with

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://api.athenaintel.com/api/v0/assets/asset_id/share \
>	-H "X-API-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"recipients": [
>	{
>	"email": "colleague@example.com",
>	"permission": "edit"
>	},
>	{
>	"email": "reviewer@example.com",
>	"permission": "view"
>	}
>	],
>	"message": "Here'\''s the document we discussed.",
>	"notify": true
>	}'

1	{
2	"asset_id": "asset_92492920-d118-42d3-95b4-00eccfe0754f",
3	"recipients_result": [
4	{
5	"email": "colleague@example.com",
6	"permission": "edit",
7	"success": true
8	}
9	]
10	}