TRANXACT.AI Help

CRM · Customer Portal

Customer Portal Users

People at your customers who sign in to the customer portal to see their invoices, orders, quotations, cases and returns: invited by email, held to their own account, with a second step where you require one. The supplier portal's people are in Supply Chain.

Type REST9 operationsBase path /api/crm/customer-portal-users

Download specification (OpenAPI 3.1) Screen: Customer Portal Users

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 › Customer Portal Users 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

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

GET/api/crm/customer-portal-usersRead customer portal users

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/customer-portal-users" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/customer-portal-users/{id}Read customer portal users

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/customer-portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/customer-portal-usersPost customer portal users

Request body

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

account_id, accountId, party_id, contact_id, email, full_name, fullName, phone, job_title, notes, mfa_required, mfaRequired

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/customer-portal-users" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"value","accountId":"value","party_id":"value","contact_id":"value","email":"value","full_name":"value"}'
POST/api/crm/customer-portal-users/{id}/reinviteReinvite

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

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

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/customer-portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/enable" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/customer-portal-users/{id}/end-sessionsEnd sessions

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/customer-portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/end-sessions" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/customer-portal-users/{id}/reset-mfaReset mfa

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/customer-portal-users/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reset-mfa" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/customer-portal-users/{id}/activityActivity

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

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 › Customer Portal Users 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.