Create a comment

curl --request POST \
  --url https://api.introw.io/api/v1/comments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "comment": "Thanks for the intro call, sending the co-sell deck over later today.",
  "authorEmail": "[email protected]"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'Thanks for the intro call, sending the co-sell deck over later today.',
    authorEmail: '[email protected]'
  })
};

fetch('https://api.introw.io/api/v1/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.introw.io/api/v1/comments"

payload = {
    "comment": "Thanks for the intro call, sending the co-sell deck over later today.",
    "authorEmail": "[email protected]"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "48291",
    "threadId": "cmt_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "isInternal": false,
    "createdAt": "2026-07-29T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Create a comment

Posts a comment on a partner’s timeline: the same comment your team and partners see in the partner portal, the CRM embed, and email/Slack notifications. This is the in-app comment composer over the API: plain-text, Markdown, or HTML comments (HTML is converted server-side), @Name / @email mentions (or an explicit mentions array), internal (org-only) visibility, and thread replies.

Where the comment lands is resolved from the targets you pass:

partnerId: the partner portal timeline. Accepts the Introw partner id or the partner’s CRM external id.
crmObjectId + crmObjectType: a deal, ticket, or other CRM object. Pass crmObjectType in your own CRM’s wording (Opportunity or Deal, whichever your CRM uses). See CRM object types. The partner is resolved from the object’s partner attribution (or pass partnerId explicitly). The comment is also synced as a note to your CRM.
taskId: a partner portal task.
formSubmissionId: a form submission (deal registration, shared lead, MDF request, …).
commissionPayoutId: a commission payout. Comments on payouts the partner cannot see yet are automatically kept internal.
threadId: reply to an existing comment (use the threadId from the create response).

Who it is posted as: authorEmail must match an organisation team member or a partner portal member of the target partner. Only team-member authors may set isInternal: true. Internal comments stay hidden from partner-facing surfaces and never trigger partner notifications.

Notifications, workflow triggers, and CRM note sync behave exactly as if the comment was posted in the app.

CRM object types

crmObjectType takes your CRM’s own name for the object, case-insensitively. Introw translates it, so there is nothing to look up or map on your side:

Deal: Salesforce Opportunity, HubSpot Deal
Company: Salesforce Account, HubSpot Company
Ticket: Salesforce Case, HubSpot Ticket
Contact: Contact in both
Lead: Lead in both

Introw’s own type names (DEAL, COMPANY, TICKET, CONTACT, LEAD) and HubSpot object type ids (0-3, 0-2, 0-5, 0-1, 0-136) resolve to the same objects.

Custom objects are the one case where the exact name matters: pass the object’s API name as your CRM shows it, for example Partner_Program__c in Salesforce or p_partner_application / 2-12345 in HubSpot. Custom types are used verbatim, not translated.

More payloads

Comment on a deal (the partner is resolved from the deal’s attribution):

curl -X POST "https://api.introw.io/api/v1/comments" \
  -H "x-api-key: $INTROW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Pricing approved on our side, over to you for the paperwork.",
    "authorEmail": "[email protected]",
    "crmObjectId": "9840193344",
    "crmObjectType": "DEAL",
    "isInternal": false
  }'

Reply in an existing thread:

curl -X POST "https://api.introw.io/api/v1/comments" \
  -H "x-api-key: $INTROW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Signed order form is in the deal room, **we are good to go**.",
    "authorEmail": "[email protected]",
    "formSubmissionId": "fsub_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "threadId": "cmt_01HVK6Y8Z8Q7J8J8J8J8J8J8J8"
  }'

Mention people with @Name / @email in the body and/or an explicit mentions array:

curl -X POST "https://api.introw.io/api/v1/comments" \
  -H "x-api-key: $INTROW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Can you take a look at the pricing on this deal @Alex?",
    "mentions": [
      "[email protected]"
    ],
    "authorEmail": "[email protected]",
    "crmObjectId": "9840193344",
    "crmObjectType": "DEAL"
  }'

POST

api

comments

Create a comment

curl --request POST \
  --url https://api.introw.io/api/v1/comments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "comment": "Thanks for the intro call, sending the co-sell deck over later today.",
  "authorEmail": "[email protected]"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    comment: 'Thanks for the intro call, sending the co-sell deck over later today.',
    authorEmail: '[email protected]'
  })
};

fetch('https://api.introw.io/api/v1/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.introw.io/api/v1/comments"

payload = {
    "comment": "Thanks for the intro call, sending the co-sell deck over later today.",
    "authorEmail": "[email protected]"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "48291",
    "threadId": "cmt_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "partnerId": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "isInternal": false,
    "createdAt": "2026-07-29T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

x-api-key

string

header

required

Introw API key shown once when the credential is created.

Body

application/json

comment

string

required

Comment body as plain text or Markdown (**bold**, *italic*, [links](url), blank-line paragraphs, and - / 1. lists). HTML fragments are also accepted and converted to the same TipTap format. Use @Name or @email to mention people; unresolved or ambiguous mentions are rejected with a short list of candidates. Formatting is preserved on the partner portal timeline.

Required string length: 1 - 20000

authorEmail

string<email>

required

Email of the person the comment is posted as. Must match an organisation team member or a partner portal member in the API key's organisation.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

mentions

string[]

People to @-mention on the comment, in addition to any @Name / @email tokens in comment. Each entry is an email or display name resolved against organisation team members and active partner portal members. Resolved mentions are appended to the comment and trigger mention notifications.

Maximum array length: 20

Required string length: 1 - 255

isInternal

boolean

When true, the comment stays hidden from partner-facing surfaces and never triggers partner notifications. Only allowed when authorEmail is an organisation team member.

partnerId

string

Partner to comment on (partner portal timeline). Accepts the Introw partner id or the partner's CRM external id.

Minimum string length: 1

taskId

integer

Partner portal task to comment on.

Required range: x <= 9007199254740991

formSubmissionId

string

Form submission (deal registration, shared lead, MDF request, …) to comment on.

Minimum string length: 1

commissionPayoutId

string

Commission payout to comment on. Comments on payouts that are not yet visible to the partner are automatically kept internal.

Minimum string length: 1

threadId

string

Thread to reply in. Use the threadId returned when the parent comment was created.

Minimum string length: 1

crmObjectId

string

External CRM identifier of the object (deal, ticket, …) to comment on. Requires crmObjectType.

Minimum string length: 1

crmObjectType

string

Type of the object in crmObjectId, in your own CRM's wording. Introw translates it: Salesforce Opportunity, Account, Case, Contact, Lead and HubSpot Deal, Company, Ticket, Contact, Lead are all accepted (case-insensitive), as are Introw's own DEAL, COMPANY, TICKET, CONTACT, LEAD. For a custom object, pass its API name exactly as your CRM shows it (for example Partner_Program__c or p_partner_application). The object must be attributed to a partner (or pass partnerId explicitly).

Minimum string length: 1

Response

Comment created successfully.

data

object

required

Show child attributes

⌘I

INTROW API

Use cases

Partner API

Forms API

CRM API

Commission payouts API

Commission lines API

Collaboration API

Embed API

Affiliate API

Create a comment

CRM object types

More payloads

Authorizations

Body

Response