Render a Grow block for the composer's canvas, as a reader or a sample

POST

/api/v1/workspaces/{workspace}/grow/blocks/render

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/blocks/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contactId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "referral", "milestoneId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "settings": "example" }'

• Your ReputeCast public URL

Permission: campaigns:view

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Body^required

Media typeapplication/json

object

contactId

string format: uuid

kind

required

string

Allowed values: referral reward

milestoneId

string format: uuid

settings

Responses

200

OK

Media typeapplication/json

object

count

required

integer format: int64

for

required

string

hidden

required

string

Allowed values: none not_on_list program_off no_program

html

required

string

listName

required

string

offAt

string format: date-time

offBy

required

string

programId

required

string

reward

required

object

button

required

string

<= 80 characters

description

required

boolean

expiry

required

boolean

hub

required

boolean

image

required

boolean

settings

required

object

button

required

string

<= 60 characters

layout

required

string

Allowed values: line progress rewards

program

string format: uuid

progress

required

boolean

share

required

Array<string>

<= 4 items

texts

required

object

many

required

string

<= 300 characters

none

required

string

<= 300 characters

one

required

string

<= 300 characters

Example

{
  "hidden": "none",
  "settings": {
    "layout": "line"
  }
}

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

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}