Skip to content
Documentation

Suggest Component Description

POST
/api/v1/workspaces/{workspace_id}/email_design_systems/{emailDesignSystemId}/components/{id}/suggest_description

Suggests a description for a component.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

emailDesignSystemId
required
integer

Email Design System ID

id
required
integer

Component ID

Request Body

Section titled “Request Body ”
object
component
required
object
id
required
integer
Example
12345
name
required
string
Example
MyComponent
label
required
string
Example
My Component
description
required
string
nullable
Example
A hero banner image with a headline and image, body text and a call to action button.
email_design_system_id
required
integer
Example
12345
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
container
boolean
nullable
template
required
string
Example
<div>My Component</div>
field_definitions
required
Array
One of:
object
type
required
string
Allowed values: text
label
required
string
group
string
nullable
liquid_variable
required
string
visible_if
string
default_value
required
string
validations
object
min_length
integer
max_length
integer
must_not_be_blank
boolean
must_not_be_default
boolean
hint
string
hidden_in_editor
boolean
hidden_from_ai
boolean
feed_field_name
string
nullable
screenshot_url
required
string
Example
https://www.example.com/screenshot.png
position
required
integer
nullable
Example
1
last_updated_by
required
object
id
required
integer
Example
12345
first_name
required
string
Example
John
last_name
required
string
Example
Smith
profile_image_url
required
string
nullable
Example
https://example.com/profile.jpg
feed_id
required
integer
nullable
Example
12345
deprecated
required
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
description
required
string

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

404

Section titled “404 ”

Not Found

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."
    ]
  }
}