Skip to content
Documentation

Submit Email for Review

POST
/api/v1/workspaces/{workspace_id}/emails/{email_id}/approval_workflow

Submits an email for review.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

email_id
required
integer

Email ID

Request Body

Section titled “Request Body ”
object
review_group_id
integer
resubmission
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
email_id
required
integer
Example
12345
status
required
string
Allowed values: in_progress completed
review_group_id
required
integer
Example
12345
creator_id
required
integer
Example
12345
creator
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
review_approvals
required
Array<object>
object
id
required
integer
Example
12345
approval_workflow_id
required
integer
Example
12345
decision
required
string
Allowed values: approved request_changes
user_id
required
integer
Example
12345
user
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
review_group
required
object
id
required
integer
Example
12345
name
required
string
Example
My Review Group
reusable
required
boolean
stages
required
Array<object>
object
position
required
integer
Example
1
approval_type
required
string
Allowed values: one_of all_of
members
required
Array<object>
object
user_id
required
integer
Example
12345
user
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

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