PATCH
/
api
/
communication-groups
/
{id}
Update Communication Group
curl --request PATCH \
  --url https://api.embedreach.com/api/communication-groups/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "emailChannelSenderId": "<string>",
  "emailHtmlBody": "<string>",
  "emailCompiledHtml": "<string>",
  "emailCss": "<string>",
  "emailTextBody": "<string>",
  "emailSubject": "<string>",
  "emailPreviewText": "<string>",
  "smsMessageBody": "<string>",
  "smsChannelSenderId": "<string>",
  "textMessageCompanyName": "<string>",
  "extraMergeFields": [
    {
      "id": "<string>",
      "type": "static",
      "templateName": "<string>",
      "displayName": "<string>",
      "staticValue": "<string>"
    }
  ],
  "textMessageMedia": [
    "<string>"
  ],
  "textMessageMediaUrls": [
    "<string>"
  ]
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "emailChannelSenderId": "<string>",
    "emailHtmlBody": "<string>",
    "emailCss": "<string>",
    "emailCompiledHtml": "<string>",
    "emailTextBody": "<string>",
    "emailSubject": "<string>",
    "emailPreviewText": "<string>",
    "smsChannelSenderId": "<string>",
    "smsMessageBody": "<string>",
    "textMessageCompanyName": "<string>",
    "textMessageMediaUrls": [
      "<string>"
    ]
  }
}

Headers

reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

id
string
required

The id of the communication group

Body

application/json
emailChannelSenderId
string | null

The id of the email channel sender

emailHtmlBody
string

The html body of the email

emailCompiledHtml
string

The compiled html body of the email

emailCss
string

The css body of the email

emailTextBody
string

The text body of the email

emailSubject
string

The subject of the email

emailPreviewText
string

The preview text of the email

smsMessageBody
string

The body of the sms message

smsChannelSenderId
string | null

The id of the sms channel sender

textMessageCompanyName
string | null

The company name to prefix the text message

extraMergeFields
object[] | null

The extra merge fields to include in the communication group

textMessageMedia
string[]

Base64 encoded png images to include in the text message

textMessageMediaUrls
string[]

The urls of the media to include in the text message

Response

Status 200 response

success
boolean
required
message
string
data
object