Skip to content
Documentation

Update Project

PATCH
/api/v1/workspaces/{workspace_id}/projects/{id}

Updates a project.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

id
required
integer

Project ID

Request Body

Section titled “Request Body ”
object
name
required

Project name

string
Example
Black Friday 2020
description

Project description

string
nullable
Example
All emails related to Black Friday 2020.
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

object
id
required
integer
Example
12345
name
required
string
Example
Black Friday 2023
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
string format: date-time
Example
2023-08-23T10:30:00.000Z
description
string
Example
Black Friday 2023 Marketing Campaign
organization_id
required
integer
Example
12345
team_id
required
integer
Example
12345
team
required
object
id
required
integer
Example
12345
name
required
string
Example
Liverpool FC
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
Example
12345
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
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

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

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