Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /elevate | Type: Application | PCID required: Yes

Tools

ToolDescription
elevate_create_or_update_matterCreate or update a matter
elevate_get_mattersGet matters
elevate_retry_get_matterRetry get matter by message ID

elevate_create_or_update_matter

Create or update a matter Parameters:
ParameterTypeRequiredDefaultDescription
businessUnitstringYesBusiness unit associated with the matter. Must already exist in the ELM system.
codestringYesAlternate Matter ID — must be unique for each matter (1–100 characters, alphanumeric).
contactEmailstringNoContact email address. Must be a valid email format.
contactFirstNamestringNoContact first name (0–255 characters, alphanumeric).
contactLastNamestringNoContact last name (0–255 characters, alphanumeric).
createdBystringNoUser who created the matter. Optional when eventType is ELM_MANAGEMATTER.MATTER.CREATED.
createdOnstringNoDate and time the matter was created. Required when eventType is ELM_MANAGEMATTER.MATTER.CREATED.
eventTypestringYesType of event. Use ELM_MANAGEMATTER.MATTER.CREATED when creating a new matter, or ELM_MANAGEMATTER.MATTER.UPDATED when updating an existing matter.
geographystringYesGeography associated with the matter. Must already exist in the ELM system.
matterLeadstringYesClient claim number — must be a valid email address format.
namestringYesMatter name (1–50 characters, alphanumeric).
parentCodestringNoCode of the parent matter, if this is a child matter (0–100 characters, alphanumeric).
statusstringYesMatter status. Only ACTIVE is accepted.
summarystringYesMatter summary (0–250 characters, alphanumeric).
typestringYesName of the Matter Type. Must already exist in the ELM system.
updatedBystringNoUser who last updated the matter. Optional when eventType is ELM_MANAGEMATTER.MATTER.UPDATED.
updatedOnstringNoDate and time the matter was last updated. Required when eventType is ELM_MANAGEMATTER.MATTER.UPDATED.

elevate_get_matters

Get matters Parameters:
ParameterTypeRequiredDefaultDescription
eventTypestringYesType of event to filter by. Use ELM_MANAGEMATTER.MATTER.CREATED for created matters or ELM_MANAGEMATTER.MATTER.UPDATED for updated matters.
namestringNoMatter name (1–50 characters).
codestringNoAlternate Matter ID — unique identifier for each matter (1–100 characters).
statusstringNoMatter status. Only ACTIVE is accepted.
typestringNoName of the Matter Type (must exist in the ELM system).
geographystringNoGeography associated with the matter (must exist in the ELM system).
businessUnitstringNoBusiness unit associated with the matter (must exist in the ELM system).

elevate_retry_get_matter

Retry get matter by message ID Parameters:
ParameterTypeRequiredDefaultDescription
message_idstringYesThe unique message ID of the matter data record to retrieve.