TRANXACT.AI Help

CRM · Service & Feedback

Surveys & Feedback

NPS and satisfaction. A detractor raises an intervention rather than sitting in a report.

Type REST11 operationsBase path /api/crm/surveysPublished as /api/v1/surveys

Download specification (OpenAPI 3.1) Screen: Surveys & Feedback

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 › Surveys & Feedback 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.surveys · 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

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

GET/api/crm/surveysList surveys & feedback

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",
      "code": "COD-000001",
      "name": "Example",
      "survey_type": "text",
      "audience_type": "prospects",
      "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "introduction": "text",
      "opens_at": "2026-10-30T09:00:00Z",
      "closes_at": "2026-10-30T09:00:00Z",
      "is_anonymous": true,
      "status": "draft"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "survey_type": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "introduction": "text",
  "opens_at": "2026-10-30T09:00:00Z",
  "closes_at": "2026-10-30T09:00:00Z",
  "is_anonymous": true,
  "status": "draft"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesSurvey code
nametextYesName
survey_typetextNoType
audience_typetextNoAudience
Allowed: prospects applicants students alumni contacts accounts segment event
segment_iduuidNoSegment
event_iduuidNoEvent
campaign_iduuidNoCampaign
introductiontextNoIntroduction
opens_attimestamp with time zoneNoOpens
closes_attimestamp with time zoneNoCloses
is_anonymousbooleanNoAnonymous
statustextNoStatus
Allowed: draft open closed archived
sent_countintegerNoNumber sent

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "survey_type": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "survey_type": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "introduction": "text",
  "opens_at": "2026-10-30T09:00:00Z",
  "closes_at": "2026-10-30T09:00:00Z",
  "is_anonymous": true,
  "status": "draft"
}

Sample request

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

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
codetextYesSurvey code
nametextYesName
survey_typetextNoType
audience_typetextNoAudience
Allowed: prospects applicants students alumni contacts accounts segment event
segment_iduuidNoSegment
event_iduuidNoEvent
campaign_iduuidNoCampaign
introductiontextNoIntroduction
opens_attimestamp with time zoneNoOpens
closes_attimestamp with time zoneNoCloses
is_anonymousbooleanNoAnonymous
statustextNoStatus
Allowed: draft open closed archived
sent_countintegerNoNumber sent

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "survey_type": "text",
  "audience_type": "prospects",
  "segment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "event_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "campaign_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "introduction": "text",
  "opens_at": "2026-10-30T09:00:00Z",
  "closes_at": "2026-10-30T09:00:00Z",
  "is_anonymous": true,
  "status": "draft"
}

Sample request

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

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/surveys/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/surveys/{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/surveys/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/surveys/{parentId}/questionsQuestions

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/surveys/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/questions" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/surveys/{parentId}/questionsQuestions

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/surveys/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/questions" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/surveys/{parentId}/questions/{lineId}Questions

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/surveys/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/questions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/surveys/{parentId}/questions/{lineId}Questions

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/surveys/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/questions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/surveys/{id}/respondRespond

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

subjectType, subjectId, score, comment; subjectType one of prospect|contact|student|alumni|applicant; answers: [{ questionId, text, number }]

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/surveys/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/respond" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subjectType":"value","subjectId":"value","score":"value","comment;":"value","text":"value","number":"value"}'

Data model

Every field of a surveys, 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
codetextread, writeSurvey code
nametextread, writeName
survey_typetextread, writeType
audience_typetextread, writeAudience
Allowed: prospects applicants students alumni contacts accounts segment event
segment_iduuidread, writeSegment
event_iduuidread, writeEvent
campaign_iduuidread, writeCampaign
introductiontextread, writeIntroduction
opens_attimestamp with time zoneread, writeOpens
closes_attimestamp with time zoneread, writeCloses
is_anonymousbooleanread, writeAnonymous
statustextread, writeStatus
Allowed: draft open closed archived
sent_countintegerread, writeNumber sent
response_countintegerread onlyResponse count
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 › Surveys & Feedback 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.