Email a share link

POST

/api/v1/shares/{id}/send

curl --request POST \
  --url http://localhost:3000/api/v1/shares/example/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "emails": [ "hello@example.com" ] }'

To up to 20 people, through the organization’s email. A 422 says why when none could be sent.

Scope: write.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

id

required

string

Share link id

Request Body^required

Media typeapplication/json

object

emails

required

Array<string>

>= 1 items <= 20 items

Example^generated

{
  "emails": [
    "hello@example.com"
  ]
}

Responses

200

How many it reached

Media typeapplication/json

object

data

required

object

emailed

required

integer

>= -9007199254740991 <= 9007199254740991

Example^generated

{
  "data": {
    "emailed": 1
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}