Skip to content
Documentation

Creates a project.

POST
/api/v1/workspaces/{workspace_id}/projects
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Black Friday 2020", "description": "All emails related to Black Friday 2020.", "team_id": 1, "default_email_design_system_id": 1, "default_brand_profile_id": 1, "default_layout_id": 1 }'

Creates a new project.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
required

Project name

string
Example
Black Friday 2020
description

Project description

string
nullable
Example
All emails related to Black Friday 2020.
team_id
required

Team ID

integer
Example
1
default_email_design_system_id

Default Email Design System ID for new emails

integer
nullable
Example
1
default_brand_profile_id

Default Brand Profile ID for new emails (must belong to the default EDS)

integer
nullable
Example
1
default_layout_id

Default Layout ID for new emails (must belong to the default EDS)

integer
nullable
Example
1

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
id
required
integer
name
required
string
created_at
required
string format: date-time
updated_at
string format: date-time
description
string
organization_id
required
integer
team_id
required
integer
team
required
object
id
required
integer
name
required
string
badge_color
required
string
Allowed values: white black gray red green blue yellow purple pink orange brown cyan lime teal indigo
workspace_id
required
integer
created_at
required
string format: date-time
default_email_design_system_id

Default Email Design System ID for new emails

integer
nullable
default_brand_profile_id

Default Brand Profile ID for new emails (must belong to the default EDS)

integer
nullable
default_layout_id

Default Layout ID for new emails (must belong to the default EDS)

integer
nullable
Example
{
  "id": 12345,
  "name": "Black Friday 2023",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z",
  "description": "Black Friday 2023 Marketing Campaign",
  "organization_id": 12345,
  "team_id": 12345,
  "team": {
    "id": 12345,
    "name": "Liverpool FC",
    "badge_color": "white",
    "workspace_id": 12345,
    "created_at": "2023-08-23T10:30:00.000Z"
  },
  "default_email_design_system_id": 1,
  "default_brand_profile_id": 1,
  "default_layout_id": 1
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}