Customers

Send customer document

Send documents to customer by instant message.Send customer document.

post/admin/customers/send-documents

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/send-documents
  • Auth: HTTP basic

Request body

typestring required

Type of message: "mail", "sms", "customer-portal", "customer-portal_and_mail"

idnumber required

Document id. Attention! In case document_type "empty" is customer's id to send message

subjectstring

It is required if the field “type” is “mail” or “customer-portal_and_mail”

document_typestring required

Type of desired document: "document", "invoice", "request", "payment", "credit_note", "empty".

template_idnumber

Template id for message, Beware! template_id MUST be before message. "template_id" will be required if "message" is empty.

messagestring

Message text. "message" will be required if "template_id" is empty.

send_to_billing_emailboolean

If the condition is true, the document will be sent to the customer's billing email address. Default value: false

copy_tostring

If an email address is specified, a copy (CC) of the document will also be sent to this address.

notification_categorystring

Optional. Notification category used for opt-in/opt-out filtering. Allowed values: "billing_and_payments", "service_and_support", "promotions_and_offers", "sub_accounts", "account_and_security", "administrative_notifications". If omitted or empty, it defaults to "billing_and_payments" for finance document types (invoice, request, payment, credit_note) and to "account_and_security" for other document types.

Example request

{
  "type": "mail",
  "id": 5,
  "subject": "Customer contract",
  "document_type": "document",
  "template_id": 15,
  "message": "Hello customer, We have sent you a contract document",
  "copy_to": "test@test.com",
  "notification_category": "billing_and_payments"
}

Response

idinteger required

Example response

{
  "id": 5
}

Changes

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