TRANXACT.AI Help

Student Lifecycle · Communication

Student Communication

Messages to a student, a section, a cohort, a program or everyone. The audience is resolved when it is sent.

Type REST7 operationsBase path /api/slcm/communicationsPublished as /api/v1/communications

Download specification (OpenAPI 3.1) Screen: Student Communication

Overview

PackageStudent Lifecycle
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 Student Lifecycle › Student Communication 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.
Tableslcm.communications · 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

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/slcm/communicationsList student communication

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",
      "message_no": "MES-000001",
      "subject": "text",
      "body": "text",
      "channel": "email",
      "audience": "students",
      "audience_ref": "text",
      "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "status": "draft",
      "scheduled_at": "2026-10-30T09:00:00Z",
      "sent_at": "2026-10-30T09:00:00Z",
      "recipient_count": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/slcm/communications?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/slcm/communications/{id}Read one communications

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",
  "message_no": "MES-000001",
  "subject": "text",
  "body": "text",
  "channel": "email",
  "audience": "students",
  "audience_ref": "text",
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "scheduled_at": "2026-10-30T09:00:00Z",
  "sent_at": "2026-10-30T09:00:00Z",
  "recipient_count": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/slcm/communications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/communicationsCreate a communications

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
subjecttextYesSubject
bodytextNoMessage
channeltextNoChannel
Allowed: email sms portal push letter
audiencetextNoAudience
Allowed: students applicants faculty advisors alumni program section cohort individual
audience_reftextNoProgram code or cohort — Used when the audience is a program or a cohort.
student_iduuidNoIndividual student
section_iduuidNoSection
statustextNoStatus
scheduled_attimestamp with time zoneNoSend at

Sample body

{
  "subject": "text",
  "body": "text",
  "channel": "email",
  "audience": "students",
  "audience_ref": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "message_no": "MES-000001",
  "subject": "text",
  "body": "text",
  "channel": "email",
  "audience": "students",
  "audience_ref": "text",
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "scheduled_at": "2026-10-30T09:00:00Z",
  "sent_at": "2026-10-30T09:00:00Z",
  "recipient_count": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/slcm/communications" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"text","body":"text","channel":"email","audience":"students","audience_ref":"text"}'
PUT/api/slcm/communications/{id}Change a communications

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
subjecttextYesSubject
bodytextNoMessage
channeltextNoChannel
Allowed: email sms portal push letter
audiencetextNoAudience
Allowed: students applicants faculty advisors alumni program section cohort individual
audience_reftextNoProgram code or cohort — Used when the audience is a program or a cohort.
student_iduuidNoIndividual student
section_iduuidNoSection
statustextNoStatus
scheduled_attimestamp with time zoneNoSend at

Sample body

{
  "subject": "text",
  "body": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "message_no": "MES-000001",
  "subject": "text",
  "body": "text",
  "channel": "email",
  "audience": "students",
  "audience_ref": "text",
  "student_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "scheduled_at": "2026-10-30T09:00:00Z",
  "sent_at": "2026-10-30T09:00:00Z",
  "recipient_count": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/slcm/communications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subject":"text","body":"text"}'
DELETE/api/slcm/communications/{id}Delete a communications

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/slcm/communications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/communications/{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/slcm/communications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/slcm/communications/{id}/sendSend

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/slcm/communications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a communications, 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
message_notextread onlyMessage no
subjecttextread, writeSubject
bodytextread, writeMessage
channeltextread, writeChannel
Allowed: email sms portal push letter
audiencetextread, writeAudience
Allowed: students applicants faculty advisors alumni program section cohort individual
audience_reftextread, writeProgram code or cohort — Used when the audience is a program or a cohort.
student_iduuidread, writeIndividual student
section_iduuidread, writeSection
statustextread, writeStatus
scheduled_attimestamp with time zoneread, writeSend at
sent_attimestamp with time zoneread onlySent at
recipient_countintegerread onlyRecipient count
sent_byuuidread onlySent by
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated 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

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 Student Lifecycle › Student Communication 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.