Docs
General - Contacts
Created: 2022-03-26 09:19:23 || Updated: 2023-01-26 08:38:50Allow your clients to interact with the ITFlow portal by creating contacts.
You can record the following information about a client contact:
- Name
- Title
- Mark as "important"
- Mark as a technical / billing contact
- Department
- Phone / Extension / Mobile
- Location
- Notes
- Portal Auth method (local/SSO)
API
/api/v1/contacts
Read - Retrieve contact information (/read.php)
- Default / No params - Returns all contacts
- contact_id - Specific contact ID from the ITFlow database
- contact_email - Specific contact via e-mail
Invoke-RestMethod -Uri "http://127.0.0.1/itflow/api/v1/contacts/read.php?api_key=XetQjoZiti5Opg7y&contact_id=8" | ConvertTo-Json { [...] |
Create - Create a new contact (/create.php)
Specify all parameters as below, even if empty. E-mail must not already exist. The new contact ID will be returned.
$uri = "http://127.0.0.1/itflow/api/v1/contacts/create.php" success count data |
Update - Update an new contact (/update.php)
Specify all parameters as below, even if empty. Same parameters as create endpoint, just additionally specify the contact_id to update.
Success (true/false) and count of affected objects (1) will be returned.
$uri = "http://127.0.0.1/itflow/api/v1/contacts/update.php" success count |