POST /comments

Create a new comment for an entity. The newly added comment will be shown in the web interface as well.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`notes`	String	Yes	Actual notes for the comment.
`entity_id`	String	Yes	Unique identifier of the entity.
`added_by`	String	No	The user who created the comment. If created via API, this contains the name given for the API key used.
`entity_type`	String	Yes	Type of the entity to create the comment for. * item - Entity that represents item * order - Entity that represents an order * item_price - Entity that represents item price * customer - Entity that represents a customer * variant - Entity that represents product variants * invoice - Invoice description * product - Entity that represents product * business_entity - Entity that represents item of type business entity * plan - Entity that represents a subscription plan * coupon - Entity that represents a discount coupon * subscription - Entity that represents a subscription of a customer * item_family - Entity that represents item family * transaction - Entity that represents a transaction. * addon - Entity that represents an addon * credit_note - Credit note description * quote - Entity that represents a quote Possible values: `"price_variant"` `"quote"` `"business_entity"` `"sales_order"` `"order"` `"transaction"` `"subscription"` `"recorded_purchase"` `"customer"` `"omnichannel_subscription"` `"addon"` `"omnichannel_subscription_item_scheduled_change"` `"item"` `"item_family"` `"item_price"` `"plan"` `"omnichannel_transaction"` `"coupon"` `"omnichannel_subscription_item"` `"invoice"` `"credit_note"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.