CRM · Broadcast
Broadcasts
Every send, with what became of it. The rates are over what was DELIVERED rather than what was sent: an open rate over sends counts the bounces as people who did not open, which flatters a bad list and punishes a clean one.
/api/crm/broadcastsPublished as /api/v1/broadcastsOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Broadcasts on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.broadcasts · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
15 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/broadcastsList broadcasts
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"broadcast_no": "BRO-000001",
"campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"purpose": "text",
"subject": "text",
"subject_local": "text",
"preheader": "text",
"body_html": "text",
"body_text": "text",
"body_local": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/broadcasts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/broadcasts/{id}Read one broadcast
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"broadcast_no": "BRO-000001",
"campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"purpose": "text",
"subject": "text",
"subject_local": "text",
"preheader": "text",
"body_html": "text",
"body_text": "text",
"body_local": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcastsCreate a broadcast
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
campaign_id | uuid | No | Campaign |
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
purpose | text | No | What it is for |
subject | text | No | Subject |
subject_local | text | No | Local subject |
preheader | text | No | Preview text — The line under the subject in an inbox. Left empty, most clients show the first line of the body, which is usually "view in browser". |
body_html | text | No | Message |
body_text | text | No | Plain text version |
body_local | text | No | Local message |
template_id | uuid | No | Template |
media_urls | _text | No | Picture or video — The public address of a picture (JPEG, PNG) or a video file (MP4) posted with the social channels. Instagram needs one; YouTube needs a video. The first address is used. |
link_url | text | No | Link |
segment_id | uuid | No | Audience |
audience_filter | jsonb | No | Audience filter |
consent_purpose | text | No | Consent purpose — Consent is checked again immediately before the send. An audience built on Monday and sent on Thursday can contain somebody who unsubscribed on Tuesday. |
scheduled_for | timestamp with time zone | No | Send at |
timezone | text | No | Time zone |
throttle_per_minute | integer | No | Most a minute — A corporate mail server sending forty thousand messages an hour is on a blocklist by lunchtime. |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"name_local": "Example",
"purpose": "text",
"subject": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"broadcast_no": "BRO-000001",
"campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"purpose": "text",
"subject": "text",
"subject_local": "text",
"preheader": "text",
"body_html": "text",
"body_text": "text",
"body_local": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","campaign_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name_local":"Example","purpose":"text","subject":"text"}'PUT/api/crm/broadcasts/{id}Change a broadcast
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
campaign_id | uuid | No | Campaign |
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
purpose | text | No | What it is for |
subject | text | No | Subject |
subject_local | text | No | Local subject |
preheader | text | No | Preview text — The line under the subject in an inbox. Left empty, most clients show the first line of the body, which is usually "view in browser". |
body_html | text | No | Message |
body_text | text | No | Plain text version |
body_local | text | No | Local message |
template_id | uuid | No | Template |
media_urls | _text | No | Picture or video — The public address of a picture (JPEG, PNG) or a video file (MP4) posted with the social channels. Instagram needs one; YouTube needs a video. The first address is used. |
link_url | text | No | Link |
segment_id | uuid | No | Audience |
audience_filter | jsonb | No | Audience filter |
consent_purpose | text | No | Consent purpose — Consent is checked again immediately before the send. An audience built on Monday and sent on Thursday can contain somebody who unsubscribed on Tuesday. |
scheduled_for | timestamp with time zone | No | Send at |
timezone | text | No | Time zone |
throttle_per_minute | integer | No | Most a minute — A corporate mail server sending forty thousand messages an hour is on a blocklist by lunchtime. |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"broadcast_no": "BRO-000001",
"campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"purpose": "text",
"subject": "text",
"subject_local": "text",
"preheader": "text",
"body_html": "text",
"body_text": "text",
"body_local": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/broadcasts/{id}Delete a broadcast
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/{id}/build-audienceBuild audience
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/build-audience" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/{id}/approveApprove
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/{id}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/{id}/unscheduleUnschedule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/unschedule" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/{id}/sendSend
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
testResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"test":"value"}'POST/api/crm/broadcasts/{id}/test-sendTest send
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test-send" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/unsubscribeUnsubscribe
Request body
The keys this action reads (* = required; "one of" lists the only values):
detail, address*, channel, broadcastId, reason; reason one of unsubscribed|hard_bounce|complained|manual|role_address|competitor|invalid|legal|deceasedResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/unsubscribe" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"detail":"value","address":"value","channel":"value","broadcastId":"value","reason;":"value"}'GET/api/crm/broadcasts/{id}/detailDetail
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/detail" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/broadcasts/overviewOverview
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/broadcasts/overview" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/broadcasts/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/broadcasts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a broadcast, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
broadcast_no | text | read only | Broadcast no |
campaign_id | uuid | read, write | Campaign |
code | text | read, write | Code |
name | text | read, write | Name |
name_local | text | read, write | Local name |
purpose | text | read, write | What it is for |
subject | text | read, write | Subject |
subject_local | text | read, write | Local subject |
preheader | text | read, write | Preview text — The line under the subject in an inbox. Left empty, most clients show the first line of the body, which is usually "view in browser". |
body_html | text | read, write | Message |
body_text | text | read, write | Plain text version |
body_local | text | read, write | Local message |
template_id | uuid | read, write | Template |
media_urls | _text | read, write | Picture or video — The public address of a picture (JPEG, PNG) or a video file (MP4) posted with the social channels. Instagram needs one; YouTube needs a video. The first address is used. |
link_url | text | read, write | Link |
segment_id | uuid | read, write | Audience |
audience_filter | jsonb | read, write | Audience filter |
audience_size | integer | read only | Audience size |
consent_purpose | text | read, write | Consent purpose — Consent is checked again immediately before the send. An audience built on Monday and sent on Thursday can contain somebody who unsubscribed on Tuesday. |
suppressed_count | integer | read only | Suppressed count |
scheduled_for | timestamp with time zone | read, write | Send at |
timezone | text | read, write | Time zone |
throttle_per_minute | integer | read, write | Most a minute — A corporate mail server sending forty thousand messages an hour is on a blocklist by lunchtime. |
status | text | read only | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
started_at | timestamp with time zone | read only | Started at |
finished_at | timestamp with time zone | read only | Finished at |
sent_count | integer | read only | Sent count |
delivered_count | integer | read only | Delivered count |
bounced_count | integer | read only | Bounced count |
opened_count | integer | read only | Opened count |
clicked_count | integer | read only | Clicked count |
replied_count | integer | read only | Replied count |
unsubscribed_count | integer | read only | Unsubscribed count |
complained_count | integer | read only | Complained count |
failed_count | integer | read only | Failed count |
social_reach | integer | read only | Social reach |
social_engagements | integer | read only | Social engagements |
cost | numeric | read only | Cost |
currency | text | read only | Currency |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
scheduled_by | uuid | read only | Scheduled by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Broadcasts for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.