curl --request POST \
--url https://platform.trylath.com/email/broadcast/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"from": "jsmith@example.com",
"subject": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"scheduledAt": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
broadcastId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
template: '<string>',
from: 'jsmith@example.com',
subject: '<string>',
topic: '<string>',
segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {},
scheduledAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://platform.trylath.com/email/broadcast/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/email/broadcast/update"
payload = {
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"from": "jsmith@example.com",
"subject": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"scheduledAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.trylath.com/email/broadcast/update"
payload := strings.NewReader("{\n \"broadcastId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"template\": \"<string>\",\n \"from\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"topic\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"scheduledAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"activityId": "<string>",
"result": {
"broadcast": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": "<unknown>",
"scheduledAt": "2023-11-07T05:31:56Z",
"status": "draft",
"counts": null,
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"from": "<string>",
"subject": "<string>"
},
"readiness": {
"ok": true,
"problems": [
{
"code": "<string>",
"message": "<string>",
"fix": "<string>"
}
]
}
}
}email.broadcast.update
Changes a draft broadcast. Sent or cancelled broadcasts cannot change. An omitted field keeps its stored value; the three optional ones — subject, segmentId and scheduledAt — accept null to clear them, which is how a schedule is cancelled or a segment widened back to everyone with consent for the topic.
curl --request POST \
--url https://platform.trylath.com/email/broadcast/update \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"from": "jsmith@example.com",
"subject": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"scheduledAt": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
broadcastId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
template: '<string>',
from: 'jsmith@example.com',
subject: '<string>',
topic: '<string>',
segmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variables: {},
scheduledAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://platform.trylath.com/email/broadcast/update', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/email/broadcast/update"
payload = {
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"from": "jsmith@example.com",
"subject": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": {},
"scheduledAt": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.trylath.com/email/broadcast/update"
payload := strings.NewReader("{\n \"broadcastId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"template\": \"<string>\",\n \"from\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"topic\": \"<string>\",\n \"segmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variables\": {},\n \"scheduledAt\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}{
"activityId": "<string>",
"result": {
"broadcast": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": "<unknown>",
"scheduledAt": "2023-11-07T05:31:56Z",
"status": "draft",
"counts": null,
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"from": "<string>",
"subject": "<string>"
},
"readiness": {
"ok": true,
"problems": [
{
"code": "<string>",
"message": "<string>",
"fix": "<string>"
}
]
}
}
}Authorizations
A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.
Headers
Replays the stored response for the same key and input; refuses different input.
Body
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$1 - 120A published template name
1 - 120An address on the project's own sending domain (email.sender.get) or on one of its verified domains
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$1 - 998The consent topic: only contacts with current granted consent for it receive the broadcast
1 - 64^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Values shared by every recipient; contact properties are added per recipient
Show child attributes
Show child attributes
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Was this page helpful?

