Skip to main content
PATCH
/
api
/
channel
/
senders
/
{id}
Update Channel Sender
curl --request PATCH \
  --url https://api.embedreach.com/api/channel/senders/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelSenderMetadata": {
    "userPart": "<string>",
    "emailReplyTo": "<string>",
    "emailFromName": "<string>",
    "from": "<string>",
    "messageServiceSid": "<string>",
    "friendlyName": "<string>"
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "channelAccountId": "<string>",
    "name": "<string>",
    "channelSenderMetadata": {
      "type": "email",
      "userPart": "<string>",
      "emailReplyTo": "<string>",
      "emailFromName": "<string>",
      "from": "<string>",
      "messageServiceSid": "<string>",
      "friendlyName": "<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 channel sender

Body

application/json
​
channelSenderMetadata
object
required

The metadata for the channel sender

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object