Pixels

Update a tracking pixel

POST/api/pixels/{pixelId}

Updates a tracking pixel's name or 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>`.

Path parameters

Name	Type	Description
pixelIdrequired	string	ID of the tracking pixel.

Request body

Name	Type	Description
name	string	Display name of the resource.
slug	string	URL slug used to access the resource.

Example request

{
  "name": "string",
  "slug": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
deletedAtrequired	string	Date and time the record was deleted, if applicable.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
slugrequired	string	URL slug used to access the resource.
teamIdrequired	string	ID of the associated team.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "name": "string",
  "slug": "string",
  "teamId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string"
}

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
  }
}

500Server error.

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

500 example

{
  "error": {
    "code": "server-error",
    "message": "Server error.",
    "status": 500
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/pixels/{pixelId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "slug": "string"
}'

PreviousList shares for a tracking pixel NextGet website retention