Create Channel Sender

Create a new channel sender

POST /api/channel/senders

Create Channel Sender

cURL

curl --request POST \
  --url https://api.embedreach.com/api/channel/senders \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelAccountId": "<string>",
  "channelSenderMetadata": {
    "type": "email",
    "userPart": "<string>",
    "emailReplyTo": "<string>",
    "emailFromName": "<string>"
  },
  "name": "<string>"
}
'

import requests

url = "https://api.embedreach.com/api/channel/senders"

payload = {
    "channelAccountId": "<string>",
    "channelSenderMetadata": {
        "type": "email",
        "userPart": "<string>",
        "emailReplyTo": "<string>",
        "emailFromName": "<string>"
    },
    "name": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    channelAccountId: '<string>',
    channelSenderMetadata: {
      type: 'email',
      userPart: '<string>',
      emailReplyTo: '<string>',
      emailFromName: '<string>'
    },
    name: '<string>'
  })
};

fetch('https://api.embedreach.com/api/channel/senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.embedreach.com/api/channel/senders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channelAccountId' => '<string>',
    'channelSenderMetadata' => [
        'type' => 'email',
        'userPart' => '<string>',
        'emailReplyTo' => '<string>',
        'emailFromName' => '<string>'
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.embedreach.com/api/channel/senders"

	payload := strings.NewReader("{\n  \"channelAccountId\": \"<string>\",\n  \"channelSenderMetadata\": {\n    \"type\": \"email\",\n    \"userPart\": \"<string>\",\n    \"emailReplyTo\": \"<string>\",\n    \"emailFromName\": \"<string>\"\n  },\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.embedreach.com/api/channel/senders")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelAccountId\": \"<string>\",\n  \"channelSenderMetadata\": {\n    \"type\": \"email\",\n    \"userPart\": \"<string>\",\n    \"emailReplyTo\": \"<string>\",\n    \"emailFromName\": \"<string>\"\n  },\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/channel/senders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channelAccountId\": \"<string>\",\n  \"channelSenderMetadata\": {\n    \"type\": \"email\",\n    \"userPart\": \"<string>\",\n    \"emailReplyTo\": \"<string>\",\n    \"emailFromName\": \"<string>\"\n  },\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "channelAccountId": "<string>",
    "name": "<string>",
    "channelSenderMetadata": {
      "userPart": "<string>",
      "emailReplyTo": "<string>",
      "emailFromName": "<string>",
      "from": "<string>",
      "messageServiceSid": "<string>",
      "friendlyName": "<string>"
    }
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<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.

Body

application/json

channelAccountId · string · required

channelSenderMetadata · object · required

Option 1

Option 2

Show child attributes

name · string

Optional friendly name of the channel sender

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes