Atlassian · Schema

InviteUsersResponse

Response for user invitation requests.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
data	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InviteUsersResponse",
  "title": "InviteUsersResponse",
  "type": "object",
  "description": "Response for user invitation requests.",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "invited": {
          "type": "array",
          "description": "Users that were successfully invited.",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email"
              },
              "accountId": {
                "type": "string"
              }
            }
          }
        },
        "failed": {
          "type": "array",
          "description": "Users that failed to be invited.",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string",
                "format": "email"
              },
              "reason": {
                "type": "string"
              }
            }
          }
        }
      },
      "example": "example_value"
    }
  }
}