Send Email

You can use send email API to send email message.

Request parameters

Name	Type	Required/Optional	Description
from	string	Required	From email
to	string	Required	To email
subject	string	Required	Email subject
htmlText	string	Required	HTML/Body text
senderName	string	Required	Sender name

Request Information

Category	Value
Http request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-messages/v2/sendEmail

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-messages/v2/sendEmail' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic AUTH_TOKEN' \
--data-raw '{
    "from": "test@test.com",
    "to": "sachin@bik.ai",
    "subject": "This is a test subject",
    "htmlText": "This is a test htmlText",
    "senderName": "Sachin"
}

'

JSON response example:

{
  "status": 200,
  "success": true,
  "data": {
    "messageId": "639952844"
  }
}

Response parameters

Name	Type	Description
status	number	Response status
success	boolean	Is successful response or not
messageId	string	Message id if any

Errors

Error Code	Meaning
400	Invalid payload -- Your request is invalid.
401	Unauthorized -- User is not authenticated.
404	Not Found -- The specified API could not be found.
500	Internal Server Error -- We had a problem with our server. Try again later.

Error response example:

{
  "status": 400,
  "errors": [
    {
      "code": 400,
      "message": "Not able to send email"
    }
  ]
}