Create a share

POST/api/share

Creates a named share for a website, board, link, or pixel with parameters and an optional custom slug.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.

Request body

Name	Type	Description
entityIdrequired	string	ID of the resource being shared.
namerequired	string	Display name of the resource.
parametersrequired	object	Configuration parameters for the resource.
shareTyperequired	integer	Type of resource made available by the share.
slug	string	URL slug used to access the resource.

Example request

{
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parameters": null,
  "shareType": 0,
  "slug": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
entityIdrequired	string	ID of the resource being shared.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

shareTyperequired	number	Type of resource made available by the share.
slugrequired	string	URL slug used to access the resource.
updatedAtrequired	string	Date and time the record was last updated.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "entityId": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "shareType": 0,
  "slug": "string",
  "updatedAt": "2024-01-15T09:30:00Z"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/share' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parameters": null,
  "shareType": 0,
  "slug": "string"
}'

PreviousList a visitor's session replays NextDelete a share