Better Stack · Schema

TeamMemberInviteRequest

Request body for inviting a team member.

IncidentsLogsMonitoringPlatformStatusUptimeObservabilityOn-CallHeartbeats

Properties

Name Type Description
email string Email address of the person to invite.
role string Role to assign.
View JSON Schema on GitHub

JSON Schema

better-stack-team-member-invite-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/better-stack/refs/heads/main/json-schema/better-stack-team-member-invite-request-schema.json",
  "title": "TeamMemberInviteRequest",
  "description": "Request body for inviting a team member.",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the person to invite.",
      "example": "[email protected]"
    },
    "role": {
      "type": "string",
      "description": "Role to assign.",
      "enum": [
        "admin",
        "member",
        "viewer"
      ],
      "example": "member"
    }
  },
  "required": [
    "email"
  ]
}