Render the Recommendations block for the composer's canvas
POST
/api/v1/workspaces/{workspace}/grow/blocks/recommendations
package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/blocks/recommendations"
payload := strings.NewReader("{ \"settings\": \"example\" }")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>") req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/blocks/recommendations';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"settings":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/blocks/recommendations \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "settings": "example" }'Permission: campaigns:view
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace slug
string
Workspace slug
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
settings
Example generated
{ "settings": "example"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
hidden
required
Array<object>
object
id
required
string
initials
required
string
name
required
string
pausedBy
required
string
state
required
string
html
required
string
options
required
Array<object>
object
hidden
required
boolean
id
required
string
initials
required
string
kind
required
string
name
required
string
showBlock
required
boolean
state
required
string
pageUrl
required
string
settings
required
object
heading
required
string
ids
required
Array<string>
intro
required
string
layout
required
string
which
required
string
shows
required
integer format: int64
Example
{ "options": [ { "kind": "link" } ], "settings": { "layout": "stacked", "which": "all" }}default
Section titled “default”Error
Media typeapplication/problem+json
object
code
Stable error code, e.g. permission_denied
string
detail
A human-readable explanation specific to this occurrence of the problem.
string
errors
Optional list of individual error details
Array<object>
object
location
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
string
message
Error message text
string
value
The value at the given location
helpers
Members who hold the missing permission
Array<string>
instance
A URI reference that identifies the specific occurrence of the problem.
string format: uri
meta
object
key
additional properties
permission
The missing permission key
string
status
HTTP status code
integer format: int64
title
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
string
type
A URI reference to human-readable documentation for the error.
string format: uri
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}