TRANXACT.AI Help

CRM · Services and actions

Ai visibility

The ai visibility service of CRM: 13 operation(s).

Type REST13 operationsBase path /api/crm/ai-visibility

Download specification (OpenAPI 3.1)

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 › Ai visibility 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/crm/ai-visibility/campaigns/{campaignId}Campaigns

Path parameters

NameTypeDescription
campaignIdstring (uuid)The record's campaignId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/ai-visibility/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/ai-visibility/campaigns/{campaignId}Campaigns

Path parameters

NameTypeDescription
campaignIdstring (uuid)The record's campaignId, 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/ai-visibility/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/ai-visibility/campaigns/{campaignId}/promptsCampaigns prompts

Path parameters

NameTypeDescription
campaignIdstring (uuid)The record's campaignId, 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/ai-visibility/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/prompts" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/ai-visibility/prompts/{id}Prompts

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 PUT "https://demo.tranxact.ai/api/crm/ai-visibility/prompts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/ai-visibility/prompts/{id}Prompts

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 DELETE "https://demo.tranxact.ai/api/crm/ai-visibility/prompts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/ai-visibility/campaigns/{campaignId}/runCampaigns run

Path parameters

NameTypeDescription
campaignIdstring (uuid)The record's campaignId, 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/ai-visibility/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/ai-visibility/campaigns/{campaignId}/runsCampaigns runs

Path parameters

NameTypeDescription
campaignIdstring (uuid)The record's campaignId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/ai-visibility/campaigns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/runs" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/ai-visibility/runs/{id}Runs

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/ai-visibility/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/ai-visibility/answers/{id}Answers

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/ai-visibility/answers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/ai-visibility/campaigns/{campaignId}/suggestionsCampaigns suggestions

Path parameters

NameTypeDescription
campaignIdstring (uuid)The record's campaignId, as a list returns it.

Response

200 with the data as JSON.

Sample request

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

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/ai-visibility/suggestions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/task" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/ai-visibility/suggestions/{id}/dismissSuggestions dismiss

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/ai-visibility/suggestions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/dismiss" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/ai-visibility/endpointsEndpoints

Request body

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

endpoints

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/ai-visibility/endpoints" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"endpoints":"value"}'

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 › Ai visibility 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.