TRANXACT.AI Help

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.

Type REST15 operationsBase path /api/crm/broadcastsPublished as /api/v1/broadcasts

Download specification (OpenAPI 3.1) Screen: Broadcasts

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.broadcasts · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
campaign_iduuidNoCampaign
codetextYesCode
nametextYesName
name_localtextNoLocal name
purposetextNoWhat it is for
subjecttextNoSubject
subject_localtextNoLocal subject
preheadertextNoPreview 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_htmltextNoMessage
body_texttextNoPlain text version
body_localtextNoLocal message
template_iduuidNoTemplate
media_urls_textNoPicture 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_urltextNoLink
segment_iduuidNoAudience
audience_filterjsonbNoAudience filter
consent_purposetextNoConsent 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_fortimestamp with time zoneNoSend at
timezonetextNoTime zone
throttle_per_minuteintegerNoMost a minute — A corporate mail server sending forty thousand messages an hour is on a blocklist by lunchtime.
notestextNoNotes
is_activebooleanNoActive

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
campaign_iduuidNoCampaign
codetextYesCode
nametextYesName
name_localtextNoLocal name
purposetextNoWhat it is for
subjecttextNoSubject
subject_localtextNoLocal subject
preheadertextNoPreview 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_htmltextNoMessage
body_texttextNoPlain text version
body_localtextNoLocal message
template_iduuidNoTemplate
media_urls_textNoPicture 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_urltextNoLink
segment_iduuidNoAudience
audience_filterjsonbNoAudience filter
consent_purposetextNoConsent 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_fortimestamp with time zoneNoSend at
timezonetextNoTime zone
throttle_per_minuteintegerNoMost a minute — A corporate mail server sending forty thousand messages an hour is on a blocklist by lunchtime.
notestextNoNotes
is_activebooleanNoActive

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

test

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/send" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"test":"value"}'
POST/api/crm/broadcasts/{id}/test-sendTest send

Path parameters

NameTypeDescription
idstring (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|deceased

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
broadcast_notextread onlyBroadcast no
campaign_iduuidread, writeCampaign
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
purposetextread, writeWhat it is for
subjecttextread, writeSubject
subject_localtextread, writeLocal subject
preheadertextread, writePreview 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_htmltextread, writeMessage
body_texttextread, writePlain text version
body_localtextread, writeLocal message
template_iduuidread, writeTemplate
media_urls_textread, writePicture 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_urltextread, writeLink
segment_iduuidread, writeAudience
audience_filterjsonbread, writeAudience filter
audience_sizeintegerread onlyAudience size
consent_purposetextread, writeConsent 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_countintegerread onlySuppressed count
scheduled_fortimestamp with time zoneread, writeSend at
timezonetextread, writeTime zone
throttle_per_minuteintegerread, writeMost a minute — A corporate mail server sending forty thousand messages an hour is on a blocklist by lunchtime.
statustextread onlyStatus
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
started_attimestamp with time zoneread onlyStarted at
finished_attimestamp with time zoneread onlyFinished at
sent_countintegerread onlySent count
delivered_countintegerread onlyDelivered count
bounced_countintegerread onlyBounced count
opened_countintegerread onlyOpened count
clicked_countintegerread onlyClicked count
replied_countintegerread onlyReplied count
unsubscribed_countintegerread onlyUnsubscribed count
complained_countintegerread onlyComplained count
failed_countintegerread onlyFailed count
social_reachintegerread onlySocial reach
social_engagementsintegerread onlySocial engagements
costnumericread onlyCost
currencytextread onlyCurrency
notestextread, writeNotes
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
scheduled_byuuidread onlyScheduled by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Broadcasts for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.