Interactions API
POST/api/v1/interactions
Product availabilityAlgaPSAAlgaDesk

Create an interaction

Optionally creates a linked AlgaPSA calendar entry in the same transaction. Set create_schedule_entry and start_time; end_time defaults to start_time plus duration (or 30 minutes). schedule_assigned_user_ids defaults to the API key owner; booking other users requires user_schedule:update. This does not create a Teams meeting.

RBAC · interaction

Request body

Content type: application/json · schema CreateInteractionBodyV1

type_idstring <uuid>Required
client_idstring <uuid>
contact_name_idstring <uuid>
ticket_idstring <uuid>
project_idstring <uuid>
opportunity_idstring <uuid>
titlestring
min length 1
notesstring
durationinteger
≥ 0
start_timestring <date-time>
end_timestring <date-time>
interaction_datestring <date-time>
create_schedule_entryboolean
Also book an AlgaPSA calendar entry. Requires start_time; defaults to false.
schedule_assigned_user_idsarray of string
Calendar assignees; omitted or empty defaults to the API key owner. Assigning others requires user_schedule:update.
itemsstring <uuid>

Response body

Success response 201 · schema InteractionSuccessV1

dataobjectRequired
tenantstring <uuid>Required
interaction_idstring <uuid>Required
type_idstring <uuid>Required
type_namestringRequiredNullable
iconstringRequiredNullable
contact_name_idstring <uuid>RequiredNullable
contact_namestringRequiredNullable
client_idstring <uuid>RequiredNullable
client_namestringRequiredNullable
user_idstring <uuid>Required
user_namestringRequiredNullable
ticket_idstring <uuid>RequiredNullable
project_idstring <uuid>RequiredNullable
opportunity_idstring <uuid>RequiredNullable
titlestringRequiredNullable
notesstringRequiredNullable
interaction_dateanyOfRequired
anyOf (option 1)string <date-time>
anyOf (option 2)string
start_timeanyOfRequired
anyOf (option 1)string <date-time>
anyOf (option 2)string
anyOf (option 3)null
end_timeanyOfRequired
anyOf (option 1)string <date-time>
anyOf (option 2)string
anyOf (option 3)null
durationintegerRequiredNullable
status_idstring <uuid>RequiredNullable
status_namestringRequiredNullable
is_status_closedbooleanRequiredNullable
visibilitystringRequired
Enum: internalclient_visible
metaobject

Response codes

201
Interaction created.
400
Validation or query parsing failure.
401
API key missing or invalid.
403
Interaction RBAC or assignment to another user’s schedule denied.
404
Interaction not found.
500
Unexpected controller or service failure.