Skip to content
Metakip Docs

Create A Page Comment Thread

POST
/pages/{pageId}/comments
curl --request POST \
  --url https://app.metakip.com/api/v1/pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "anchor": { "quote": "example", "prefix": "example", "suffix": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
pageId
required
string format: uuid

The UUID of the page.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
body
required
string
>= 1 characters <= 10000 characters
anchor
required
object
quote
required
string
>= 1 characters <= 100000 characters
prefix
Any of:
string
<= 200 characters
suffix
Any of:
string
<= 200 characters
Examplegenerated
{
  "body": "example",
  "anchor": {
    "quote": "example",
    "prefix": "example",
    "suffix": "example"
  }
}

Responses

Section titled “Responses”

201

Section titled “201”

The requested comment data.

Media typeapplication/json
object
thread
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
pageId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
anchor
required
object
quote
required
string
>= 1 characters <= 100000 characters
prefix
Any of:
string
<= 200 characters
suffix
Any of:
string
<= 200 characters
status
required
string
Allowed values: open resolved
createdBy
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdAt
required
string
updatedAt
required
string
resolvedBy
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
resolvedAt
required
Any of:
string
comments
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
threadId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
authorId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
authorName
required
Any of:
string
authorImage
required
Any of:
string
body
required
Any of:
string
createdAt
required
string
updatedAt
required
string
deletedAt
required
Any of:
string
Example
{
  "thread": {
    "status": "open"
  }
}

403

Section titled “403”

The API token is missing a required scope: pages:comment.

Media typeapplication/json

Structured error returned when the request cannot be completed.

object
error
required

Error details for programmatic handling.

object
code
required

Stable error code.

string
message
required

Human-readable explanation.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}