Grambell API

Send EMAIL

Send email messages through the Grambell API, the API allows you to send emails through the email service that is useful for sending transactional emails, marketing emails, and newsletters.

Authentication

To authenticate to the API you need to add api-key header to your requests with an active subscription key supporting the API in use, you can get your keys from subscriptions page under your AMS account.

Endpoint

endpoint is available at:

https://amsapis.azure-api.net/communication/grambell​/send-email

Request

The request you send will include the details of the following:

{
  "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "receiver": {
    "subject": "string",
    "fromName": "string",
    "to": [
      {
        "name": "string",
        "email": "string"
      }
    ],
    "cc": [
      {
        "name": "string",
        "email": "string"
      }
    ]
  },
  "variables": "string"
}

Breakdown of request fields is as follow:

  • channelId: The channel id to send the email through
  • templateId : The template id to use for the email
  • receiver: The receiver of the email
    • subject: The subject of the email
    • fromName: The name of the sender
    • to: The list of receivers
      • name: The name of the receiver
      • email: The email of the receiver
    • cc: The list of cc receivers
      • name: The name of the cc receiver
      • email: The email of the cc receiver
  • variables: The variables to use in the email template

Response

The response will be a JSON object with the following fields:

{
  "processingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string"
}

Open API Documentation

You can view the API documentation in open API format from here

Send SMS

Send sms messages through the Grambell API, the API allows you to send sms through the sms service that is useful for sending transactional sms and marketing sms.

Authentication

To authenticate to the API you need to add api-key header to your requests with an active subscription key supporting the API in use, you can get your keys from subscriptions page under your AMS account.

Endpoint

endpoint is available at:

https://amsapis.azure-api.net/communication/grambell​/send-sms

Request

The request you send will include the details of the following:

{
  "channelId": "string",
  "receiver": "string",
  "message": {
    "text": "string"
  }
}

Breakdown of request fields is as follow:

  • channelId: The channel id to send the sms through
  • receiver: The receiver of the sms
  • message: The message to send
    • text: The text of the sms

Response

The response if successful will be code 200 OK, example response:

200 OK

Open API Documentation

You can view the API documentation in open API format from here

← Centroid API
AB Routing →