For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/users/send-invitation-emails.md. A documentation index is available at /llms.txt.
Language
Datadog site

Send invitation emails

POSThttps://api.datadoghq.com/api/v2/user_invitationshttps://api.us3.datadoghq.com/api/v2/user_invitationshttps://api.us5.datadoghq.com/api/v2/user_invitationshttps://api.datadoghq.eu/api/v2/user_invitationshttps://api.ap1.datadoghq.com/api/v2/user_invitationshttps://api.ap2.datadoghq.com/api/v2/user_invitationshttps://api.uk1.datadoghq.com/api/v2/user_invitationshttps://api.ddog-gov.com/api/v2/user_invitationshttps://api.us2.ddog-gov.com/api/v2/user_invitations

Overview

Sends emails to one or more users inviting them to join the organization.

This endpoint requires the user_access_invite permission.

OAuth apps require the user_access_invite authorization scope to access this endpoint.

Request

Body Data (required)

Field
Type
Description
data [required]
[object]

List of user invitations.

Response

OK

User invitations as returned by the API.

Field
Type
Description
data
[object]

Array of user invitations.

Code Example

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/user_invitations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": [
    {
      "relationships": {
        "user": {
          "data": {
            "id": "6cf192b6-d1d9-11ec-ad3d-da7ad0900002",
            "type": "users"
          }
        }
      },
      "type": "user_invitations"
    }
  ]
}
EOF