---
title: "Send shared dashboard invitation email"
method: POST
path: "/api/v1/dashboard/public/{token}/invitation"
tags: ["Dashboards"]
---

# Send shared dashboard invitation email

`POST /api/v1/dashboard/public/{token}/invitation`

Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list.

## Path parameters

- `token` string, required

## Request body

- SharedDashboardInvites — Invitations data and metadata that exists for a shared dashboard returned by the API.
  - `data` union, required — An object or list of objects containing the information for an invitation to a shared dashboard.
    - SharedDashboardInvitesDataObject — Object containing the information for an invitation to a shared dashboard.
      - `attributes` SharedDashboardInvitesDataObjectAttributes, required — Attributes of the shared dashboard invitation
        - `created_at` string, date-time — When the invitation was sent.
        - `email` string — An email address that an invitation has been (or if used in invitation request, will be) sent to.
        - `has_session` boolean — Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
        - `invitation_expiry` string, date-time — When the invitation expires.
        - `session_expiry` string, date-time, nullable — When the invited user's session expires. null if the invitation has no associated session.
        - `share_token` string — The unique token of the shared dashboard that was (or is to be) shared.
      - `type` 'public_dashboard_invitation', required — Type for shared dashboard invitation request body.
    - SharedDashboardInvitesDataObject[] — A list of objects containing the information for an invitation(s) to a shared dashboard.
      - `attributes` SharedDashboardInvitesDataObjectAttributes, required — Attributes of the shared dashboard invitation
        - `created_at` string, date-time — When the invitation was sent.
        - `email` string — An email address that an invitation has been (or if used in invitation request, will be) sent to.
        - `has_session` boolean — Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
        - `invitation_expiry` string, date-time — When the invitation expires.
        - `session_expiry` string, date-time, nullable — When the invited user's session expires. null if the invitation has no associated session.
        - `share_token` string — The unique token of the shared dashboard that was (or is to be) shared.
      - `type` 'public_dashboard_invitation', required — Type for shared dashboard invitation request body.
  - `meta` SharedDashboardInvitesMeta — Pagination metadata returned by the API.
    - `page` SharedDashboardInvitesMetaPage — Object containing the total count of invitations across all pages
      - `total_count` integer — The total number of invitations on this shared board, across all pages.

## Response `201`

OK

- SharedDashboardInvites — Invitations data and metadata that exists for a shared dashboard returned by the API.
  - `data` union, required — An object or list of objects containing the information for an invitation to a shared dashboard.
    - SharedDashboardInvitesDataObject — Object containing the information for an invitation to a shared dashboard.
      - `attributes` SharedDashboardInvitesDataObjectAttributes, required — Attributes of the shared dashboard invitation
        - `created_at` string, date-time — When the invitation was sent.
        - `email` string — An email address that an invitation has been (or if used in invitation request, will be) sent to.
        - `has_session` boolean — Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
        - `invitation_expiry` string, date-time — When the invitation expires.
        - `session_expiry` string, date-time, nullable — When the invited user's session expires. null if the invitation has no associated session.
        - `share_token` string — The unique token of the shared dashboard that was (or is to be) shared.
      - `type` 'public_dashboard_invitation', required — Type for shared dashboard invitation request body.
    - SharedDashboardInvitesDataObject[] — A list of objects containing the information for an invitation(s) to a shared dashboard.
      - `attributes` SharedDashboardInvitesDataObjectAttributes, required — Attributes of the shared dashboard invitation
        - `created_at` string, date-time — When the invitation was sent.
        - `email` string — An email address that an invitation has been (or if used in invitation request, will be) sent to.
        - `has_session` boolean — Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email).
        - `invitation_expiry` string, date-time — When the invitation expires.
        - `session_expiry` string, date-time, nullable — When the invited user's session expires. null if the invitation has no associated session.
        - `share_token` string — The unique token of the shared dashboard that was (or is to be) shared.
      - `type` 'public_dashboard_invitation', required — Type for shared dashboard invitation request body.
  - `meta` SharedDashboardInvitesMeta — Pagination metadata returned by the API.
    - `page` SharedDashboardInvitesMetaPage — Object containing the total count of invitations across all pages
      - `total_count` integer — The total number of invitations on this shared board, across all pages.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `429` — Too many requests

---

[API](https://skmtc.net/datadog/apis/api-v1.md) · [All operations](https://skmtc.net/datadog/apis/api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datadog/api-v1/versions/ca5871004d26/schema)