Orvelt

Create a project

POST
/projects

Create a project with its own team. The creator is added to the project team.

Requires a Business session or a resource-authorized OAuth token and the applicable member access. API keys are not accepted.

Authorization

cookieorvelt-biz.session_token<token>

An existing Business session. Browser requests must also pass origin and CSRF checks.

Request Body

application/json
  1. body
slug*string
Match^[a-z0-9]+(?:-[a-z0-9]+)*$
Length1 <= length <= 80
name*string
Length1 <= length <= 200
description?|
Defaultnull
status?string
Default"draft"
Value in"draft""published""archived"
metadata?
Default{}
isPrivate?boolean

Private projects have no public page and collect only private feedback and answers. The storefront cannot be private, and a project with public opinions cannot become private.

Defaultfalse

Response Body

OK

application/json
  1. response
project*
Example Request
curl -X POST 'https://api.orvelt.com/v1/projects' \
  -H 'Content-Type: application/json' \
  -d '{
  "slug": "string",
  "name": "string"
}'
Example Response
{
  "project": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organizationId": "string",
    "teamId": "string",
    "slug": "string",
    "routeSlug": "string",
    "name": "string",
    "description": "string",
    "status": "draft",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "assets": [
      "http://example.com"
    ],
    "privateAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}