API ReferenceapimembershipPOST /v1/teams/{id}/invites

POST /v1/teams/\{id\}/invites

Service: membership · operationId: (none)

Required scopes

(no scope declared — review service config)

Path parameters

  • id (string) required

Request body

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "format": "email"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "member"
      ],
      "default": "member"
    }
  },
  "required": [
    "email"
  ]
}

Responses

201 Team invite created

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "team_id": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "member"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "accepted",
        "revoked"
      ]
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "team_id",
    "email",
    "role",
    "status",
    "created_at"
  ]
}

403 Not allowed to invite members

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

404 Team not found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

500 Unexpected error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://membership.platform.loop.health/v1/teams/{id}/invites \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'