Skip to content
calternal docs

Share a Files item

POST
/api/v1/files/shares
curl --request POST \
  --url https://example.com/api/v1/files/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "access": "example", "path": "example", "recipient_id": "example", "recipient_kind": "user" }'

Requires a signed-in User with the data scope and permission to share the Item. It returns 400 when the share request is invalid or 403 when access is denied. Route: /api/v1/files/shares. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
access
required
string
path
required
string
recipient_id
required
string
recipient_kind

The default preserves existing User clients; Groups retain one grant (#1028).

string
Allowed values: user group

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
access
required
string
created_at
required

Original grant time, in Unix seconds; access changes preserve it (§54/#1034).

integer format: int64
direction
required
string
group_name
string | null
id
required
string
owner_id
required
string
path
required
string
recipient_id
required
string
recipient_kind
required

The stored recipient identity; access resolves Group membership live (#1028).

string
Allowed values: user group
Example
{
  "recipient_kind": "user"
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}