---
title: "Invite helper"
method: POST
path: "/v1/helpers"
tags: ["Owner"]
---

# Invite helper

`POST /v1/helpers`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/helpers`
- Auth: HTTP bearer

## Request body

- InviteHelperRequest
  - `email` string, email, required
  - `name` string
  - `permissions` object
    - `settings` boolean, required
    - `billing` boolean, required
    - `alerts_scam_urgent` boolean, required
    - `see_caller_content` boolean, required
    - `answer_questions` boolean, required

## Response `200`

OK

- InviteHelperResponse
  - `helper` object, required
    - `id` string, required
    - `name` string, nullable, required
    - `email` string, nullable, required
    - `status` 'invited' | 'active' | 'removed', required
    - `permissions` object, required
      - `settings` boolean, required
      - `billing` boolean, required
      - `alerts_scam_urgent` boolean, required
      - `see_caller_content` boolean, required
      - `answer_questions` boolean, required
    - `setUpThis` boolean, required
    - `invitedAt` string, date-time, required
    - `acceptedAt` string, date-time, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `413`: Body over the limit (64 KB; 512 KB for contact import).
- `500`: Unexpected server error (reported to Sentry).

---

[API](https://skmtc.dev/vicem/apis/vicem-api.md) · [All operations](https://skmtc.dev/vicem/apis/vicem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vicem/apis/vicem-api/revisions/9efcec07e5f4?raw)