---
title: "Bulk onboard endpoints with subscriptions"
method: POST
path: "/v1/projects/{projectID}/onboard"
tags: ["Onboard"]
---

# Bulk onboard endpoints with subscriptions

`POST /v1/projects/{projectID}/onboard`

This endpoint bulk-creates endpoints with subscriptions from a JSON body. A CSV file upload is also accepted over raw HTTP as multipart/form-data with a "file" field; generated SDK clients only expose the JSON body.

## Path parameters

- `projectID` string, required

## Query parameters

- `dry_run` boolean

## Request body

- ModelsBulkOnboardRequest
  - `items` ModelsOnboardItem[]
    - `auth_password` string
    - `auth_username` string
    - `event_type` string
    - `name` string
    - `url` string

## Response `200`

OK

- object
  - `message` string
  - `status` boolean
  - `data` ModelsBulkOnboardDryRunResponse
    - `errors` ModelsOnboardValidationError[]
      - `field` string
      - `message` string
      - `row` integer
    - `total_rows` integer
    - `valid_count` integer

## Other responses

- `202` — Accepted
- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/frain-dev/apis/convoy-api-reference.md) · [All operations](https://skmtc.net/frain-dev/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frain-dev/convoy-api-reference/versions/dbd5b4f9cf13/schema)