Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
onboard
Bulk onboard endpoints with subscriptions
curl --request POST \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/onboard \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "auth_password": "<string>",
      "auth_username": "<string>",
      "event_type": "<string>",
      "name": "<string>",
      "url": "<string>"
    }
  ]
}
'
{
  "message": "<string>",
  "status": true,
  "data": {
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "row": 123
      }
    ],
    "total_rows": 123,
    "valid_count": 123
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

projectID
string
required

Project ID

Query Parameters

dry_run
boolean

Validate without creating resources

Body

Send application/json with an items array, or multipart/form-data with a CSV file in field file (max 10 MB form). Do not combine both in one request.

items
object[]

Response

OK (dry run only)

message
string
status
boolean
data
object