FRfrain-dev
Onboard

Bulk onboard endpoints with subscriptions

Changed on

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.

post/v1/projects/{projectID}/onboard

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    API key in header Authorization

Path parameters

projectIDstring required

Project ID

Query parameters

dry_runboolean

Validate without creating

Request body

Response

OK

messagestring
statusboolean

Changes