POST
/
api
/
v1
/
createItem
/
{spaceId}
curl --request POST \
  --url https://hero.page/api/v1/createItem/{spaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "listId": "<string>",
  "title": "<string>",
  "note": "<string>",
  "image": "<string>",
  "link": "<string>",
  "generated_by": {
    "model": "<string>",
    "job_id": "<string>",
    "appDescription": "<string>",
    "appSubtitle": "<string>",
    "appID": "<string>",
    "appName": "<string>",
    "appIcon": "<string>",
    "appTags": [
      "<string>"
    ]
  },
  "isAIPrompt": true
}'
{
  "id": "<string>",
  "title": "<string>",
  "note": "<string>",
  "img": "<string>",
  "url": "<string>",
  "pageID": "<string>",
  "spaceID": "<string>",
  "sortIndex": 123,
  "send_approval_email": true,
  "readMorePageSlug": "<string>",
  "is_archived": true,
  "completed": true,
  "actionType": "<string>",
  "fileURL": "<string>",
  "fileName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "is_image_full_width": true,
  "submitted_by": {},
  "urlMetadata": {},
  "image_generated_on_hero": true,
  "isAIPrompt": true,
  "owner_uid": "<string>",
  "ticketType": "<string>",
  "generated_by": {}
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

spaceId
string
required

The ID of the space where the item will be created. Must be a non-empty string.

Body

application/json
listId
string

The ID of the list within the space where the item will be created. Must be a non-empty string.

title
string

The title of the item. Must be a non-empty string.

note
string

The note content of the item. Optional.

image
string

The URL of the image associated with the item. Optional.

link
string

The URL of the link associated with the item. Optional.

generated_by
object
isAIPrompt
boolean
default: false

Response

200 - application/json
id
string
title
string
note
string
img
string
url
string
pageID
string
spaceID
string
sortIndex
integer
send_approval_email
boolean
readMorePageSlug
string
is_archived
boolean
completed
boolean
actionType
string
fileURL
string
fileName
string
createdAt
string
is_image_full_width
boolean
submitted_by
object
urlMetadata
object
image_generated_on_hero
boolean
isAIPrompt
boolean
owner_uid
string
ticketType
string
generated_by
object