TRANXACT.AI Help

CRM · Services and actions

Linkedin invitations

The linkedin invitations service of CRM: 9 operation(s).

Type REST9 operationsBase path /api/crm/linkedin-invitations

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 › Linkedin invitations 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.

POST/api/crm/linkedin-invitations/previewPreview

Request body

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

recordType, ids, template

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/linkedin-invitations/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recordType":"value","ids":"value","template":"value"}'
POST/api/crm/linkedin-invitations/queueQueue

Request body

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

recordType, template, ids, campaignId; recordType one of lead|lead_contact|contact|prospect

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/linkedin-invitations/queue" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recordType":"value","template":"value","ids":"value","campaignId;":"value"}'
GET/api/crm/linkedin-invitationsRead linkedin invitations

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/linkedin-invitations" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/linkedin-invitations/{id}/sentSent

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

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

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

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

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/linkedin-invitations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/linkedin-invitations/settingsSettings

Request body

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

cap

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/linkedin-invitations/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cap":"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 › Linkedin invitations 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.