Customers | B2C

Add a comment to a customer

Sample request for adding a comment without notifications:

POST /api/PrivateCustomers/AddComment
{
   "CustomerId": "customer@example.com",
   "CommentText": "Customer requested a callback regarding their recent order.",
   "CreatedBy": "CRM System"
}
        

Sample request for adding a comment with email notification:

POST /api/PrivateCustomers/AddComment
{
   "CustomerId": "customer@example.com",
   "CommentText": "Thank you for contacting us. We have received your inquiry and will respond shortly.",
   "SendEmail": true,
   "EmailSubject": "Inquiry Received",
   "EmailTo": "customer@example.com",
   "EmailFrom": "support@yourcompany.com",
   "SenderName": "Customer Support"
}
        

Sample request for adding a comment with SMS notification:

POST /api/PrivateCustomers/AddComment
{
   "CustomerId": "customer@example.com",
   "CommentText": "Your order has been shipped and will arrive within 2-3 business days.",
   "SendSms": true,
   "SmsPhoneNumber": "+4712345678"
}
        

Notes:

  • CreatedBy defaults to the current API user's username if not specified.
  • EmailTo, EmailFrom, SenderName, and SmsPhoneNumber will fall back to the store's (or global) default settings in Omnium if not specified.
  • EmailTo falls back to the customer's email. SmsPhoneNumber falls back to the customer's phone.
post/api/PrivateCustomers/AddComment

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/PrivateCustomers/AddComment
  • Auth: API key in header Authorization

Request body

customerIdstring nullable

Customer ID (e.g., email address or customer number)

commentTextstring nullable

The comment text/message content

createdBystring nullable

The sender/creator of the comment (e.g., "API", "System", external service name). Defaults to "API" if not specified.

tagsstring[] nullable

Tags for categorizing/filtering comments

marketIdstring nullable

Market ID (optional, uses customer's market if not specified)

sendEmailboolean

Send email notification to customer

emailSubjectstring nullable

Email subject line

emailTostring nullable

Email recipient address. Falls back to customer's email if not specified.

emailCcstring nullable

Email CC recipients (semicolon separated)

emailBccstring nullable

Email BCC recipients (semicolon separated)

emailFromstring nullable

Email from address. Falls back to store's default email if not specified.

senderNamestring nullable

Sender display name for email and SMS notifications. Falls back to store's default sender name if not specified.

sendSmsboolean

Send SMS notification to customer

smsPhoneNumberstring nullable

Phone number for SMS. Falls back to customer's phone if not specified.

Response

Comment added successfully

Changes

No recorded changes to this operation across all 1 revision of this API.