Skip to main content
POST
/
notifications
/
email
/
v1
/
providers
/
sendgrid
Save SendGrid credentials
curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/notifications/email/v1/providers/sendgrid \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "sendGridApiKey": "SG.9ipFP4b17yT-Fff2GGrH8FF0GqdkBohXAEI4GnTSj9Q=",
  "sendGridTemplateID": "d-8284bb9646a040499d5cfa28d272a094",
  "sendGridUnsubscribeGroupID": "33832",
  "senderName": "Emailer",
  "senderEmail": "noreply@em123.example.com",
  "allowEmailReplies": false,
  "senderEmailForReplies": "reply@em123.example.com",
  "isEnabled": true
}'
{
  "data": {
    "allowEmailReplies": true,
    "sendGridApiKey": "sendgrid_key",
    "sendGridTemplateID": "template_id",
    "sendGridUnsubscribeGroupID": "12312",
    "senderEmail": "noreply@em123.example.com",
    "senderEmailForReplies": "reply@em123.example.com",
    "senderName": "Emailer",
    "repliesWebhook": "https://notifications-us.cometchat.io/email/v1/sendgrid/replies?token=GY40_1kWlnc2Lo7Lk8vWWxiNJ6BmEEpV4eZsUeMr328"
  }
}

Authorizations

​
apikey
string
header
required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json
​
sendGridApiKey
string
required

The SendGrid API key

Example:

"SG.9ipFP4b17yT-Fff2GGrH8FF0GqdkBohXAEI4GnTSj9Q="

​
sendGridTemplateID
string
required

The SendGrid template ID

Example:

"d-8284bb9646a040499d5cfa28d272a094"

​
sendGridUnsubscribeGroupID
string
required

The SendGrid unsubscribe group ID

Example:

"33832"

​
senderName
string
required

The name of the sender

Example:

"Emailer"

​
senderEmail
string
required

The email address of the sender

Example:

"noreply@em123.example.com"

​
allowEmailReplies
boolean
default:false
required
​
senderEmailForReplies
string | null

The email address when replies are enabled (optional)

Example:

"reply@em123.example.com"

​
isEnabled
boolean

Enable SendGrid

Response

200 - application/json

A list of push notification's settings

​
data
any[]
​
meta
object
⌘I