Create a new project - Flow

POST

/

project

Create a new project

curl --request POST \
  --url https://backend.branch.flowengineering.com/project \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>' \
  --data '
{
  "name": "<string>",
  "copyAutomations": true,
  "copyDataModel": true,
  "copyFromProjectId": "<string>",
  "copySkills": true,
  "copyViews": true,
  "seedFromTemplate": true
}
'

import requests

url = "https://backend.branch.flowengineering.com/project"

payload = {
    "name": "<string>",
    "copyAutomations": True,
    "copyDataModel": True,
    "copyFromProjectId": "<string>",
    "copySkills": True,
    "copyViews": True,
    "seedFromTemplate": True
}
headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    customer: '<customer>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    copyAutomations: true,
    copyDataModel: true,
    copyFromProjectId: '<string>',
    copySkills: true,
    copyViews: true,
    seedFromTemplate: true
  })
};

fetch('https://backend.branch.flowengineering.com/project', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ai_model": "<string>",
  "created_at": "<string>",
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>"
}

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Body

application/json

name

string

required

Display name for the new project

copyAutomations

boolean

Copy the source project automations. Defaults to true.

copyDataModel

boolean

Copy the source project data model (categories, fields, tag options). Defaults to true.

copyFromProjectId

string

When provided, copies structure from the specified project into the new one. Which parts are copied is controlled by the copy* flags below (all default to true, so omitting them copies everything, as before). Takes precedence over seedFromTemplate.

copySkills

boolean

Copy the source project skills (and skill folders). Defaults to true.

copyViews

boolean

Copy the source project saved views. Requires copyDataModel. Defaults to true.

seedFromTemplate

boolean

Seed the new project from the workspace default-template project (data model, saved views, and dashboards). Ignored when copyFromProjectId is set. Defaults to false — an omitted flag yields a blank project.

Response

201 - application/json

ai_model

string

required

created_at

string

required

id

string

required

name

string

required

slug

string

required

Create a new project

curl --request POST \
  --url https://backend.branch.flowengineering.com/project \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>' \
  --data '
{
  "name": "<string>",
  "copyAutomations": true,
  "copyDataModel": true,
  "copyFromProjectId": "<string>",
  "copySkills": true,
  "copyViews": true,
  "seedFromTemplate": true
}
'

import requests

url = "https://backend.branch.flowengineering.com/project"

payload = {
    "name": "<string>",
    "copyAutomations": True,
    "copyDataModel": True,
    "copyFromProjectId": "<string>",
    "copySkills": True,
    "copyViews": True,
    "seedFromTemplate": True
}
headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    customer: '<customer>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    copyAutomations: true,
    copyDataModel: true,
    copyFromProjectId: '<string>',
    copySkills: true,
    copyViews: true,
    seedFromTemplate: true
  })
};

fetch('https://backend.branch.flowengineering.com/project', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ai_model": "<string>",
  "created_at": "<string>",
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>"
}