Skip to content

Add collaborators

POST
/v1/artifacts/{id}/collaborators
curl --request POST \
--url https://shareout.site/v1/artifacts/example/collaborators \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "emails": [ "hello@example.com" ], "role": "owner" }'
id
required
string

Artifact ID (e.g. art_abc123).

Media typeapplication/json
object
emails
required
Array<string>
role
required
string
Allowed values: owner editor viewer

Added

Access denied

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}