POST/organizations/{organizationId}/projects

Create a project

Creates a project and its initial development environment.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired

namestringrequired

slugstringrequired

owner_idstringoptional

tagsarray<string>optional

notification_settingsobjectoptional

Responses

201application/json

Project created.

{
  "id": "prj_01J8F5KM4MAB0V7YQ6P3N2R8D1",
  "organization_id": "org_01J8F1Q6N6VTX4E8W9R2D0A7B3",
  "name": "Northstar mobile",
  "slug": "northstar-mobile",
  "status": "active",
  "owner": {
    "id": "mem_01J8F3D2P9Q7V6N5M4K",
    "name": "Mira Kowalska"
  },
  "tags": [
    "mobile",
    "q4-launch"
  ],
  "environment_count": 3,
  "metrics": {
    "weekly_active_users": 12840,
    "api_success_rate": 99.98
  },
  "etag": "W/\"project-86\"",
  "created_at": "2026-02-12T14:00:00Z",
  "updated_at": "2026-09-02T16:42:10Z"
}

idstringoptional

organization_idstringoptional

namestringoptional

slugstringoptional

statusstringoptional

ownerobjectoptional

tagsarray<string>optional

environment_countintegeroptional

metricsobjectoptional

etagstringoptional

created_atstring · date-timeoptional

updated_atstring · date-timeoptional

409

Project slug already exists.

curl --request POST \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/projects' \ --header 'Idempotency-Key: 5ba89923-8c6d-44a3-9ab7-2fbbdb865f9a' \ --header 'Content-Type: application/json' \ --data '{ "name": "Northstar mobile", "slug": "northstar-mobile", "owner_id": "mem_01J8F3D2P9Q7V6N5M4K", "tags": [ "mobile", "q4-launch" ], "notification_settings": { "failed_deployments": true }}'

{ "id": "prj_01J8F5KM4MAB0V7YQ6P3N2R8D1", "organization_id": "org_01J8F1Q6N6VTX4E8W9R2D0A7B3", "name": "Northstar mobile", "slug": "northstar-mobile", "status": "active", "owner": { "id": "mem_01J8F3D2P9Q7V6N5M4K", "name": "Mira Kowalska" }, "tags": [ "mobile", "q4-launch" ], "environment_count": 3, "metrics": { "weekly_active_users": 12840, "api_success_rate": 99.98 }, "etag": "W/\"project-86\"", "created_at": "2026-02-12T14:00:00Z", "updated_at": "2026-09-02T16:42:10Z" }