CRM · Services and actions
Social
The social service of CRM: 45 operation(s).
/api/crm/socialOverview
| 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 › Social 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
45 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/social/signalsSignals
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/signals" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/signals/{id}Signals
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/signalsSignals
Request body
The keys this action reads (* = required; "one of" lists the only values):
platform, body*, author_handle, author_name, url, posted_at, rating, product_area, language, account_idResponse
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/social/signals" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"platform":"value","body":"value","author_handle":"value","author_name":"value","url":"value","posted_at":"value"}'POST/api/crm/social/ingestIngest
Request body
The keys this action reads (* = required; "one of" lists the only values):
account_code*, signals*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/social/ingest" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_code":"value","signals":"value"}'POST/api/crm/social/signals/{id}/classifySignals classify
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/classify" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/signals/{id}/rereadSignals reread
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):
intent*, severity, sentiment, topic, product_area, urgency, is_spam, is_actionable, rationale; intent one of complaint|service_request|product_defect|outage|billing_dispute|delivery_issue|safety_concern|compliance_concern|praise|question|purchase_intent|feature_request|competitor_mention|news|spam|other; severity one of none|low|moderate|high|critical; sentiment one of positive|neutral|negative|mixed; urgency one of routine|soon|urgent|immediateResponse
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reread" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"intent":"value","severity":"value","sentiment":"value","topic":"value","product_area":"value","urgency":"value"}'POST/api/crm/social/signals/{id}/correlateSignals correlate
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/correlate" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/signals/{id}/attachSignals attach
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):
module, resource*, record_id, relation, note; relation one of about|author|affected|referenced|similarResponse
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/attach" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"module":"value","resource":"value","record_id":"value","relation":"value","note;":"value"}'POST/api/crm/social/correlations/{id}/decideCorrelations decide
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):
status; status one of confirmed|rejectedResponse
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/social/correlations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"status;":"value"}'POST/api/crm/social/signals/{id}/scoreSignals score
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/signals/{id}/processSignals process
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/process" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/signals/{id}/assignSignals assign
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):
assigned_toResponse
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"assigned_to":"value"}'POST/api/crm/social/signals/{id}/dismissSignals dismiss
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):
reason*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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dismiss" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'GET/api/crm/social/incidentsIncidents
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/incidents" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/incidents/{id}Incidents
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/social/incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/incidentsIncidents
Request body
The keys this action reads (* = required; "one of" lists the only values):
title*, description, category, product_area, severity, signal_ids; category one of outage|product_defect|delivery|billing|safety|compliance|pricing|staff|policy|reputation|other; severity one of sev1|sev2|sev3|sev4Response
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/social/incidents" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"value","description":"value","category":"value","product_area":"value","severity":"value","signal_ids;":"value"}'POST/api/crm/social/signals/{id}/incidentSignals incident
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):
title, description, category, severity; category one of outage|product_defect|delivery|billing|safety|compliance|pricing|staff|policy|reputation|other; severity one of sev1|sev2|sev3|sev4Response
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/incident" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"value","description":"value","category":"value","severity;":"value"}'POST/api/crm/social/incidents/{id}/attachIncidents attach
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):
signal_idsResponse
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/social/incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/attach" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"signal_ids":"value"}'POST/api/crm/social/incidents/{id}/statusIncidents status
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):
status*, owner_id; status one of open|investigating|identified|remediating|monitoring|resolved|closedResponse
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/social/incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/status" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"status":"value","owner_id;":"value"}'POST/api/crm/social/incidents/{id}/root-causesIncidents root causes
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):
hypothesis*, category, module, resource, record_id, evidence, corrective_action, preventive_action, confidence; category one of process|product|supply|system|people|policy|communication|external|unknownResponse
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/social/incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/root-causes" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"hypothesis":"value","category":"value","module":"value","resource":"value","record_id":"value","evidence":"value"}'POST/api/crm/social/root-causes/{id}/decideRoot causes decide
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):
state, corrective_action, preventive_action; state one of investigating|confirmed|ruled_outResponse
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/social/root-causes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"state":"value","corrective_action":"value","preventive_action;":"value"}'POST/api/crm/social/incidents/{id}/analyzeIncidents analyze
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/social/incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/analyze" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/actionsActions
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/actions" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/actionsActions
Request body
The keys this action reads (* = required; "one of" lists the only values):
signal_id, incident_id, kind*, title, detail, rationale, expected_effect, priority, owner_id, due_at; kind one of respond|case|work_order|task|escalate|remediate|product_change|process_change|refund|recall|monitor|no_action; priority one of low|medium|high|urgentResponse
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/social/actions" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"signal_id":"value","incident_id":"value","kind":"value","title":"value","detail":"value","rationale":"value"}'POST/api/crm/social/actions/{id}/approveActions approve
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):
owner_idResponse
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/social/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"owner_id":"value"}'POST/api/crm/social/actions/{id}/rejectActions reject
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):
reason*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/social/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/crm/social/actions/{id}/completeActions complete
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):
note, record_noResponse
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/social/actions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value","record_no":"value"}'POST/api/crm/social/signals/{id}/respondSignals respond
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):
body, action_id, channel, tone; channel one of public_reply|direct_message|review_reply|email|phone|noneResponse
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/respond" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"body":"value","action_id":"value","channel":"value","tone;":"value"}'PUT/api/crm/social/responses/{id}Responses
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):
body, channel; channel one of public_reply|direct_message|review_reply|email|phone|noneResponse
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/social/responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"body":"value","channel;":"value"}'POST/api/crm/social/responses/{id}/approveResponses approve
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):
bodyResponse
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/social/responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"body":"value"}'POST/api/crm/social/responses/{id}/publishResponses publish
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):
posted_manually, urlResponse
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/social/responses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/publish" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"posted_manually":"value","url":"value"}'POST/api/crm/social/signals/{id}/measureSignals measure
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):
window_hours, action_id, notesResponse
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/social/signals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/measure" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"window_hours":"value","action_id":"value","notes":"value"}'POST/api/crm/social/incidents/{id}/measureIncidents measure
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):
window_hours, action_id, notesResponse
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/social/incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/measure" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"window_hours":"value","action_id":"value","notes":"value"}'POST/api/crm/social/feedbackFeedback
Request body
The keys this action reads (* = required; "one of" lists the only values):
signal_id, target, verdict*, corrected, reason, action_id, correlation_id, outcome_id; target one of classification|risk_score|correlation|action|response|outcome; verdict one of agree|partly|disagreeResponse
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/social/feedback" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"signal_id":"value","target":"value","verdict":"value","corrected":"value","reason":"value","action_id":"value"}'POST/api/crm/social/feedback/{id}/applyFeedback apply
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/social/feedback/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/apply" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/loopLoop
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/loop" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/reports/signalsReports signals
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/reports/signals" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/reports/incidentsReports incidents
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/reports/incidents" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/reports/actionsReports actions
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/reports/actions" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/reports/outcomesReports outcomes
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/reports/outcomes" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/reports/learningReports learning
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/reports/learning" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/reports/loopReports loop
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/reports/loop" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/social/handlesHandles
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/social/handles" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/social/handlesHandles
Request body
The keys this action reads (* = required; "one of" lists the only values):
platform*, handle, subject_type, subject_id, display_name; subject_type one of account|contact|prospect|student|supplier|employeeResponse
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/social/handles" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"platform":"value","handle":"value","subject_type":"value","subject_id":"value","display_name;":"value"}'DELETE/api/crm/social/handles/{id}Handles
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 DELETE "https://demo.tranxact.ai/api/crm/social/handles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"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 › Social 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.