TRANXACT.AI Help

CRM · Marketing

Campaigns

What is being run, to whom, at what cost and to what effect.

Type REST12 operationsBase path /api/crm/campaignsPublished as /api/v1/campaigns

Download specification (OpenAPI 3.1) Screen: Campaigns

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 › Campaigns 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.campaigns · 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

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

GET/api/crm/campaignsList campaigns

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",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "campaign_no": "CAM-000001",
      "name": "Example",
      "campaign_type": "text",
      "channel": "text",
      "audience_type": "prospects",
      "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "objective": "text",
      "start_date": "2026-10-30",
      "end_date": "2026-10-30",
      "status": "planned",
      "budget_amount": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_no": "CAM-000001",
  "name": "Example",
  "campaign_type": "text",
  "channel": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "objective": "text",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "planned",
  "budget_amount": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
location_iduuidNoLocation id
nametextYesName
campaign_typetextNoType
channeltextNoChannel
audience_typetextNoAudience
Allowed: prospects students applicants accounts contacts alumni segment all
segment_iduuidNoSegment
objectivetextNoObjective
start_datedateNoStarts
end_datedateNoEnds
statustextNoStatus
Allowed: planned approved active paused completed cancelled
budget_amountnumericNoBudget
actual_costnumericNoSpent so far
currencytextNoCurrency
target_reachintegerNoTarget reach
target_conversionsintegerNoTarget conversions
cost_center_iduuidNoCost center
owner_iduuidNoOwner

Sample body

{
  "name": "Example",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_type": "text",
  "channel": "text",
  "audience_type": "prospects"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_no": "CAM-000001",
  "name": "Example",
  "campaign_type": "text",
  "channel": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "objective": "text",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "planned",
  "budget_amount": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/campaigns" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","campaign_type":"text","channel":"text","audience_type":"prospects"}'
PUT/api/crm/campaigns/{id}Change a campaigns

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
location_iduuidNoLocation id
nametextYesName
campaign_typetextNoType
channeltextNoChannel
audience_typetextNoAudience
Allowed: prospects students applicants accounts contacts alumni segment all
segment_iduuidNoSegment
objectivetextNoObjective
start_datedateNoStarts
end_datedateNoEnds
statustextNoStatus
Allowed: planned approved active paused completed cancelled
budget_amountnumericNoBudget
actual_costnumericNoSpent so far
currencytextNoCurrency
target_reachintegerNoTarget reach
target_conversionsintegerNoTarget conversions
cost_center_iduuidNoCost center
owner_iduuidNoOwner

Sample body

{
  "name": "Example",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_no": "CAM-000001",
  "name": "Example",
  "campaign_type": "text",
  "channel": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "objective": "text",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "status": "planned",
  "budget_amount": "1250.00"
}

Sample request

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

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

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/members" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/campaigns/{parentId}/membersMembers

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/members" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/campaigns/{parentId}/members/{lineId}Members

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 PUT "https://demo.tranxact.ai/api/crm/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/members/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/campaigns/{parentId}/members/{lineId}Members

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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 DELETE "https://demo.tranxact.ai/api/crm/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/members/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/campaigns/{id}/populatePopulate

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):

segmentId

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/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/populate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"segmentId":"value"}'
POST/api/crm/campaigns/{id}/launchLaunch

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

Data model

Every field of a campaigns, 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
location_iduuidread, writeLocation id
campaign_notextread onlyCampaign no
nametextread, writeName
campaign_typetextread, writeType
channeltextread, writeChannel
audience_typetextread, writeAudience
Allowed: prospects students applicants accounts contacts alumni segment all
segment_iduuidread, writeSegment
objectivetextread, writeObjective
start_datedateread, writeStarts
end_datedateread, writeEnds
statustextread, writeStatus
Allowed: planned approved active paused completed cancelled
budget_amountnumericread, writeBudget
actual_costnumericread, writeSpent so far
currencytextread, writeCurrency
target_reachintegerread, writeTarget reach
target_conversionsintegerread, writeTarget conversions
cost_center_iduuidread, writeCost center
owner_iduuidread, writeOwner
created_attimestamp with time zoneread onlyCreated at
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated 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 › Campaigns 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.