iris.lead
Module iris.lead
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_iris.lead_1.3.0.png)
ballerinax/iris.lead Ballerina library
Overview
This is a generated connector for IRIS Leads API v1.6.4 OpenAPI specification.
Connect with the Leads API to interact with your lead data.
Includes management of fields, user assignments, status changes, tasks, appointments, email, text messaging, and document attachments.
Create custom reports without limits using the data already housed within your CRM.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a IRIS CRM account
- Obtain tokens by following this guide
Quickstart
To use the IRIS Leads connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/iris.lead
module into the Ballerina project.
import ballerinax/iris.lead;
Step 2: Create a new connector instance
Create a lead:ApiKeysConfig
with the API key obtained, and initialize the connector with it.
lead:ApiKeysConfig config = { xApiKey: "<API_KEY>" } lead:Client baseClient = check new Client(config);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to get a list of leads using the connector.
Get a list of leads
public function main() returns error? { lead:InlineResponse20016 response = check baseClient->getLeads(); log:printInfo(response.toString()); }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
iris.lead: Client![](/images/permalink.svg)
This is a generated connector for IRIS Leads API v1.6.4 OpenAPI specification.
Connect with the Leads API to interact with your lead data.
Includes management of fields, user assignments, status changes, tasks, appointments, email, text messaging, and document attachments.
Create custom reports without limits using the data already housed within your CRM.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a IRIS account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ClientConfiguration clientConfig)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
getLeads![](/images/permalink.svg)
function getLeads(int? page, int? perPage, string? sortBy, string sortDir, int? 'group, int? mid, int? campaign, int? 'source, int? status, int? category, int? user, string? dateFilter, string? startDate, string? endDate, string? email) returns InlineResponse20016|error
Get a list of leads
Parameters
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
- sortBy string? (default ()) - Sorting of leads by the field value
- sortDir string (default "asc") - Direction of sorting
- 'group int? (default ()) - Filter leads by a group id
- mid int? (default ()) - Filter leads by a merchant id
- campaign int? (default ()) - Filter leads by a campaign id
- 'source int? (default ()) - Filter leads by a source id
- status int? (default ()) - Filter leads by a status id
- category int? (default ()) - Filter leads by a status category id
- user int? (default ()) - Filter leads by a user id
- dateFilter string? (default ()) - Filtering leads by a date range depends on this filter
- startDate string? (default ()) - Filter leads by a date in ISO 8601 format (Y-m-d\TH:i:sP) (Please note that
+
sign should be encoded to%2B
)
- endDate string? (default ()) - Filter leads by a date in ISO 8601 format (Y-m-d\TH:i:sP) (Please note that
+
sign should be encoded to%2B
)
- email string? (default ()) - Filter leads by a email
Return Type
- InlineResponse20016|error - A JSON array of leads
createLead![](/images/permalink.svg)
function createLead(V1LeadsBody payload) returns InlineResponse20017|error
Create a lead
Parameters
- payload V1LeadsBody - Lead details
Return Type
- InlineResponse20017|error - Lead has been created successfully
getDetailedLeadInformation![](/images/permalink.svg)
function getDetailedLeadInformation(int leadId) returns InlineResponse20018|error
Get detailed lead information
Parameters
- leadId int - Lead Id
Return Type
- InlineResponse20018|error - Detailed lead information
updateLead![](/images/permalink.svg)
function updateLead(int leadId, LeadsLeadidBody payload) returns InlineResponse20019|error
Update a lead
Parameters
- leadId int - Lead Id
- payload LeadsLeadidBody - Lead changes (send only fields you want to change)
Return Type
- InlineResponse20019|error - Lead has been updated successfully
deleteRecordFromALeadRecordSet![](/images/permalink.svg)
function deleteRecordFromALeadRecordSet(int leadId, int catId, int recordId) returns InlineResponse20020|error
Delete record from a lead record set
Return Type
- InlineResponse20020|error - The record has been deleted successfully
getAvailableLeadFields![](/images/permalink.svg)
function getAvailableLeadFields(int? page, int? perPage) returns InlineResponse20021|error
Get a list of available lead fields
Return Type
- InlineResponse20021|error - A list of available fields
createNewLeadField![](/images/permalink.svg)
function createNewLeadField(LeadsFieldsBody payload) returns LeadField|error
Create a new lead field
Parameters
- payload LeadsFieldsBody - LeadField data
getLeadField![](/images/permalink.svg)
Get a lead field
Parameters
- fieldId int - Field Id
updateLeadField![](/images/permalink.svg)
function updateLeadField(int fieldId, FieldsFieldidBody payload) returns LeadField|error
Update a lead field
updateLeadFieldOrderPosition![](/images/permalink.svg)
function updateLeadFieldOrderPosition(int fieldId, LeadFieldOrder payload) returns InlineResponse20022|error
Update a lead field order position
Return Type
- InlineResponse20022|error - Updated Lead field order position
getAllLeadFieldTabs![](/images/permalink.svg)
function getAllLeadFieldTabs(int? page, int? perPage) returns InlineResponse20023|error
Get a list of all lead field tabs
Return Type
- InlineResponse20023|error - A list of all lead field tabs
createLeadFieldTab![](/images/permalink.svg)
function createLeadFieldTab(LeadFieldTab payload) returns LeadFieldTab|error
Create a lead field tab
Parameters
- payload LeadFieldTab - LeadFieldTab data
Return Type
- LeadFieldTab|error - Create a lead field tab
getLeadFieldTab![](/images/permalink.svg)
function getLeadFieldTab(int tabId) returns LeadFieldTab|error
Get a lead field tab
Parameters
- tabId int - Lead field tab Id
Return Type
- LeadFieldTab|error - Lead field tab
updateLeadFieldTab![](/images/permalink.svg)
function updateLeadFieldTab(int tabId, LeadFieldTab payload) returns LeadFieldTab|error
Update a lead field tab
Return Type
- LeadFieldTab|error - Updated lead field tab
getPricingTemplates![](/images/permalink.svg)
function getPricingTemplates(int? page, int? perPage) returns InlineResponse20024|error
Get pricing templates
Return Type
- InlineResponse20024|error - A list of pricing templates
getLeadNotes![](/images/permalink.svg)
function getLeadNotes(int leadId, int? page, int? perPage) returns InlineResponse20025|error
Get lead notes
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20025|error - A list of lead notes
createLeadNote![](/images/permalink.svg)
function createLeadNote(int leadId, LeadidNotesBody payload) returns InlineResponse20026|error
Create a lead note
Return Type
- InlineResponse20026|error - Note has been added successfully
getLeadAppointments![](/images/permalink.svg)
function getLeadAppointments(int leadId, int? page, int? setFor, int? setBy, int? modifiedBy, int? confirmedBy, int? rescheduledBy, int? seenBy, int? rescheduledCount, boolean? done, int? perPage, string? sortBy, string? sortDir, string? dateFilter, string? startDate, string? endDate) returns InlineResponse20027|error
Get lead appointments
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- setFor int? (default ()) - Filter by the user for who appointment was created
- setBy int? (default ()) - Filter by the user for who have created an appointment
- modifiedBy int? (default ()) - Filter by the user for who have modified an appointment
- confirmedBy int? (default ()) - Filter by the user for who have confirmed an appointment
- rescheduledBy int? (default ()) - Filter by the user for who have rescheduled an appointment
- seenBy int? (default ()) - Filter by the user for who have mark an appointment as seen
- rescheduledCount int? (default ()) - Filter by the count of rescheduling
- done boolean? (default ()) - Filter by the done flag
- perPage int? (default ()) - Count of records per page
- sortBy string? (default ()) - Sort appointments by columns
- sortDir string? (default ()) - Sort direction
- dateFilter string? (default ()) - Filtering appointments by a date range depends on this filter
- startDate string? (default ()) - Filter appointments by a date in format Y-m-d
- endDate string? (default ()) - Filter leads by a date in format Y-m-d
Return Type
- InlineResponse20027|error - A list of lead appointments
createLeadAppointment![](/images/permalink.svg)
function createLeadAppointment(int leadId, LeadidAppointmentsBody payload) returns InlineResponse20028|error
Create a lead appointment
Return Type
- InlineResponse20028|error - Appointment has been created successfully
populatePdfDocument![](/images/permalink.svg)
function populatePdfDocument(int leadId, int applicationId) returns InlineResponse20029|error
Populate PDF Document
Return Type
- InlineResponse20029|error - Document populated successfully.
getLeadTasks![](/images/permalink.svg)
function getLeadTasks(int leadId, int? page, int? perPage) returns InlineResponse20030|error
Get lead tasks
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20030|error - A list of lead tasks
createLeadTask![](/images/permalink.svg)
function createLeadTask(int leadId, LeadidTasksBody payload) returns InlineResponse20031|error
Create a lead task
Return Type
- InlineResponse20031|error - Task has been created successfully
getAssignedUsers![](/images/permalink.svg)
function getAssignedUsers(int leadId, int? page, int? perPage) returns InlineResponse20032|error
Get a list of assigned users
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20032|error - A list of assigned users
assignUser![](/images/permalink.svg)
function assignUser(int leadId, LeadidUsersBody payload) returns InlineResponse20033|error
Assign a user
Return Type
- InlineResponse20033|error - User has been assigned successfully
unassignUserFromLead![](/images/permalink.svg)
function unassignUserFromLead(int leadId, int userId) returns InlineResponse20034|error
Unassign a user from a lead
Return Type
- InlineResponse20034|error - User has been unassigned successfully
getAvailableDocuments![](/images/permalink.svg)
function getAvailableDocuments(int leadId, int? page, int? perPage) returns InlineResponse20035|error
Get a list of available documents
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20035|error - A list of available documents
getAvailableDocumentLabels![](/images/permalink.svg)
function getAvailableDocumentLabels(int? page, int? perPage) returns InlineResponse20036|error
Get a list of available document labels
Return Type
- InlineResponse20036|error - A list of available labels
downoladDocument![](/images/permalink.svg)
Download a document
sendEmailToLeadWithTemplate![](/images/permalink.svg)
function sendEmailToLeadWithTemplate(int leadId, int templateId, EmailsTemplateidBody payload) returns InlineResponse20040|error
Send an email to lead with template
Parameters
- leadId int - Lead Id
- templateId int - Template Id
- payload EmailsTemplateidBody - Payload data
Return Type
- InlineResponse20040|error - Result of proccess
getEmailTemplates![](/images/permalink.svg)
function getEmailTemplates() returns InlineResponse20041|error
Get a list of email templates
Return Type
- InlineResponse20041|error - A list of available email templates
downloadMailboxEmailAttachment![](/images/permalink.svg)
function downloadMailboxEmailAttachment(int leadId, int emailId, int attachmentId) returns string|error
Download a mailbox email attachment
sendSmsToLeadWithSelectedSmsTemplate![](/images/permalink.svg)
function sendSmsToLeadWithSelectedSmsTemplate(int leadId, int templateId, SmsTemplateidBody payload) returns InlineResponse20042|error
Send an SMS to lead with selected SMS template
Return Type
- InlineResponse20042|error - Result of proccess
getSmsTemplates![](/images/permalink.svg)
function getSmsTemplates() returns InlineResponse20043|error
Get list of SMS templates
Return Type
- InlineResponse20043|error - A list of available SMS templates
getAllLeadCampaignActivity![](/images/permalink.svg)
function getAllLeadCampaignActivity(int leadId, int? page, int? perPage) returns InlineResponse20044|error
Get a list of all lead campaign activity
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20044|error - A list of activity
getAllLeadDeletionActivity![](/images/permalink.svg)
function getAllLeadDeletionActivity(int leadId, int? page, int? perPage) returns InlineResponse20045|error
Get a list of all lead deletion activity
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20045|error - A list of activity
getAllLeadDuplicateActivity![](/images/permalink.svg)
function getAllLeadDuplicateActivity(int leadId, int? page, int? perPage) returns InlineResponse20046|error
Get a list of all lead duplicate activity
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20046|error - A list of activity
getAllLeadLinksActivity![](/images/permalink.svg)
function getAllLeadLinksActivity(int leadId, int? page, int? perPage) returns InlineResponse20047|error
Get a list of all lead links activity
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20047|error - A list of activity
getAllLeadSourceActivity![](/images/permalink.svg)
function getAllLeadSourceActivity(int leadId, int? page, int? perPage) returns InlineResponse20048|error
Get a list of all lead source activity
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20048|error - A list of activity
getAllLeadStatusActivity![](/images/permalink.svg)
function getAllLeadStatusActivity(int leadId, int? page, int? perPage) returns InlineResponse20049|error
Get a list of all lead status activity
Parameters
- leadId int - Lead Id
- page int? (default ()) - Page number
- perPage int? (default ()) - Count of records per page
Return Type
- InlineResponse20049|error - A list of activity
getAvailableCampaigns![](/images/permalink.svg)
function getAvailableCampaigns() returns InlineResponse20052|error
Get a list of available campaigns
Return Type
- InlineResponse20052|error - A list of available campaigns
getAvailableGroups![](/images/permalink.svg)
function getAvailableGroups(int? status) returns InlineResponse20053|error
Get a list of available groups
Parameters
- status int? (default ()) - Status Id
Return Type
- InlineResponse20053|error - A list of available groups
getAvailableSources![](/images/permalink.svg)
function getAvailableSources() returns InlineResponse20054|error
Get a list of available sources
Return Type
- InlineResponse20054|error - A list of available sources
getAvailableStatuses![](/images/permalink.svg)
function getAvailableStatuses(int? 'group) returns InlineResponse20055|error
Get a list of available statuses
Parameters
- 'group int? (default ()) - Group Id
Return Type
- InlineResponse20055|error - A list of available statuses
getAvailableUsers![](/images/permalink.svg)
function getAvailableUsers(int? page, int? perPage) returns InlineResponse20032|error
Get a list of available users
Return Type
- InlineResponse20032|error - A list of available users
Records![](/images/permalink.svg)
iris.lead: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
X-API-KEY
iris.lead: Apiv1leadsFields![](/images/permalink.svg)
Fields
- id string - Field Id
- 'record string? - Record Id
- value string - Field value
iris.lead: BriefCampaignInfo![](/images/permalink.svg)
Fields
- id int? - Campaign Id
- name string? - Campaign name
iris.lead: BriefCategoryInfo![](/images/permalink.svg)
Fields
- id int? - Status category Id
- name string? - Status category name
iris.lead: BriefEmailTemplate![](/images/permalink.svg)
Fields
- id int? -
- title string? -
iris.lead: BriefGroupInfo![](/images/permalink.svg)
Fields
- id int? - Group Id
- name string? - Group name
iris.lead: BriefLeadInfo![](/images/permalink.svg)
Fields
- id int? - Lead Id
- mid int? - Lead merchant Id
- name string? - Lead name
- 'group BriefGroupInfo? -
- category BriefCategoryInfo? -
- status BriefStatusInfo? -
- campaign BriefCampaignInfo? -
- 'source BriefSourceInfo? -
- created string? - Lead creation date (Y-m-d\TH:i:sP)
- modified string? - Lead modification date (Y-m-d\TH:i:sP)
iris.lead: BriefSmsTemplate![](/images/permalink.svg)
Fields
- id int? -
- title string? -
iris.lead: BriefSourceInfo![](/images/permalink.svg)
Fields
- id int? - Source Id
- name string? - Source name
iris.lead: BriefStatusInfo![](/images/permalink.svg)
Fields
- id int? - Status Id
- name string? - Status name
iris.lead: BriefTabInfo![](/images/permalink.svg)
Fields
- id int? - Tab Id
- name string? - Tab name
iris.lead: BriefUserInfo![](/images/permalink.svg)
Fields
- id int? - User Id
- name string? - User name
iris.lead: BriefUserInfoWithClass![](/images/permalink.svg)
Fields
- id int? - User Id
- username string? - User username
- full_name string? - User name
- email string? - User email
- status string? - User status
- 'class string? - User class
iris.lead: CampaignActivity![](/images/permalink.svg)
Fields
- id int? - Activity Id
- newValue string? - New value of activity
- assignedBy int? - User Id
- assignedAt string? - Assigned date (Y-m-d\TH:i:sP)
iris.lead: CategoryWithStatuses![](/images/permalink.svg)
Fields
- id int? - Status category Id
- name string? - Status category name
- statuses BriefStatusInfo[]? -
iris.lead: DeletionActivity![](/images/permalink.svg)
Fields
- id int? - Activity Id
- deletedId int? - User Id
- deletedAt string? - Date of deletion (Y-m-d\TH:i:sP)
- undeletedId int? - User Id
- undeletedAt string? - Date of undeletion (Y-m-d\TH:i:sP)
iris.lead: DuplicateActivity![](/images/permalink.svg)
Fields
- id int? - Activity Id
- oldLeadId int? - Old lead Id
- newLeadId int? - New lead Id
- duplicatedBy int? - User Id
- duplicatedAt string? - Date of duplication (Y-m-d\TH:i:sP)
iris.lead: FieldsFieldidBody![](/images/permalink.svg)
Fields
- Fields Included from *LeadField
- override boolean? - Flag for overriding existing special field
iris.lead: FileLabel![](/images/permalink.svg)
Fields
- id int? - Label Id
- 'order int? - Label display order
- name string? - Label name
iris.lead: InlineResponse20016![](/images/permalink.svg)
Fields
- data BriefLeadInfo[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20017![](/images/permalink.svg)
Fields
- leadId int? - Lead Id
- message string? - Result message
iris.lead: InlineResponse20018![](/images/permalink.svg)
Fields
- general BriefLeadInfo? -
- details InlineResponse20018Details[]? -
iris.lead: InlineResponse20018Details![](/images/permalink.svg)
Fields
- id int? -
- name string? -
- 'type string? -
- 'record int? - Record Id
- fields InlineResponse20018Fields[]? -
iris.lead: InlineResponse20018Fields![](/images/permalink.svg)
Fields
- id string? - Field Id
- 'field string? - Field name
- value string? - Field value
iris.lead: InlineResponse20019![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20020![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20021![](/images/permalink.svg)
Fields
- data LeadField[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20022![](/images/permalink.svg)
Fields
- result string? -
iris.lead: InlineResponse20023![](/images/permalink.svg)
Fields
- data LeadFieldTab[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20024![](/images/permalink.svg)
Fields
- data InlineResponse20024Data[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20024Data![](/images/permalink.svg)
Fields
- id int? - Template Id
- name string? - Template name
- created_by int? - Template creator
- created_at string? - Template modification date and time (ISO-8601)
- modified_by int? - Template modification date and time (ISO-8601)
- modified_at string? - Last template editor
- fields_changed_by int? - Last fields editor
- fields_changed_at string? - Last fileds modification date and time (ISO-8601)
- values InlineResponse20024Values[]? -
iris.lead: InlineResponse20024Values![](/images/permalink.svg)
Fields
- field_id int? -
- value string? -
iris.lead: InlineResponse20025![](/images/permalink.svg)
Fields
- data InlineResponse20025Data[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20025Data![](/images/permalink.svg)
Fields
- id int? - Note Id
- sticky string? - Pin note to top
- tab BriefTabInfo? -
- text string? - Note text
- created string? - Note creation date and time (ISO-8601)
- modified string? - Note modification date and time (ISO-8601)
iris.lead: InlineResponse20026![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20027![](/images/permalink.svg)
Fields
- data LeadAppointment[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20028![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20029![](/images/permalink.svg)
Fields
- message string? -
- url string? -
iris.lead: InlineResponse20030![](/images/permalink.svg)
Fields
- data InlineResponse20030Data[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20030Data![](/images/permalink.svg)
Fields
- id int? - Task Id
- user BriefUserInfo? -
- text string? - Task description
- date string? - Task Date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- confirmed string? - Task confirmed date and time in format ISO 8601 (Y-m-d\TH:i:sP)
iris.lead: InlineResponse20031![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20032![](/images/permalink.svg)
Fields
- data BriefUserInfoWithClass[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20033![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20034![](/images/permalink.svg)
Fields
- message string? -
iris.lead: InlineResponse20035![](/images/permalink.svg)
Fields
- data InlineResponse20035Data[]? - A list of lead documents
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20035Data![](/images/permalink.svg)
Fields
- id string? - Document Id
- name string? - Name
- size string? - Size
- tab InlineResponse20035Tab? -
- label InlineResponse20035Label? -
iris.lead: InlineResponse20035Label![](/images/permalink.svg)
Fields
- id int? -
- name string? -
iris.lead: InlineResponse20035Tab![](/images/permalink.svg)
Fields
- id int? -
- name string? -
iris.lead: InlineResponse20036![](/images/permalink.svg)
Fields
- data FileLabel[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20040![](/images/permalink.svg)
Fields
- message string? - Email has been sent successfully
- emailId string? - Id of email what will be sended to lead
iris.lead: InlineResponse20041![](/images/permalink.svg)
Fields
- data BriefEmailTemplate[]? -
iris.lead: InlineResponse20042![](/images/permalink.svg)
Fields
- message string? - SMS has been sent successfully.
- receiver string? - Phone number of SMS receiver.
iris.lead: InlineResponse20043![](/images/permalink.svg)
Fields
- data BriefSmsTemplate[]? -
iris.lead: InlineResponse20044![](/images/permalink.svg)
Fields
- data CampaignActivity[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20045![](/images/permalink.svg)
Fields
- data DeletionActivity[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20046![](/images/permalink.svg)
Fields
- data DuplicateActivity[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20047![](/images/permalink.svg)
Fields
- data LinksActivity[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20048![](/images/permalink.svg)
Fields
- data SourceActivity[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20049![](/images/permalink.svg)
Fields
- data StatusActivity[]? -
- links Links? -
- meta Meta? -
iris.lead: InlineResponse20052![](/images/permalink.svg)
Fields
- data BriefCampaignInfo[]? - A list of lead campaigns
iris.lead: InlineResponse20053![](/images/permalink.svg)
Fields
- data BriefGroupInfo[]? - A list of lead groups
iris.lead: InlineResponse20054![](/images/permalink.svg)
Fields
- data BriefSourceInfo[]? - A list of lead sources
iris.lead: InlineResponse20055![](/images/permalink.svg)
Fields
- data CategoryWithStatuses[]? - A list of lead statuses
iris.lead: LeadAppointment![](/images/permalink.svg)
Fields
- id int? - Appointment Id
- user BriefUserInfo? -
- set_for BriefUserInfo? -
- set_at string? - Appointment creation date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- set_by BriefUserInfo? -
- modified string? - Appointment modification date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- modified_by BriefUserInfo? -
- text string? - Appointment description
- date string? - Appointment date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- date_end string? - Appointment end date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- done string? - Is appointment done?
- confirmed string? - Appointment confirmed date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- confirmed_by BriefUserInfo? -
- seen string? - Appointment seen date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- seen_by BriefUserInfo? -
- rescheduled string? - Appointment rescheduled date and time in format ISO 8601 (Y-m-d\TH:i:sP)
- rescheduled_by BriefUserInfo? -
- rescheduled_count int? -
iris.lead: LeadField![](/images/permalink.svg)
Fields
- id int? - Field Id
- tab int - Field tab Id
- label string - Field label
- 'type string - Field type
- length int? - Field size
- 'default string? - Field default value
- alignment string? - Field alignment
- searchable int? - Searchable field
- special string? - Field special value
- options LeadfieldOptions? -
- 'order int? -
- readOnly boolean? - Whether the field is read only
- required boolean? - Whether the field is required
iris.lead: LeadfieldOptions![](/images/permalink.svg)
Fields
- dropdown LeadfieldOptionsDropdown? - Add new list item
- dupecheck boolean? - Enable dupecheck
- contactid string? - Id of contact field
- mask string? - Field mask
- copy LeadfieldOptionsCopy? - Copy button properties
- hyperlink boolean? - Enable hyperlink
- sms boolean? - Enable SMS
- dialer boolean? - Enable dialer
- googlemaps record {}? - Google Maps search properties
- zipcode_autocomplete LeadfieldOptionsZipcodeAutocomplete? - ZIP Code autofill properties
iris.lead: LeadfieldOptionsCopy![](/images/permalink.svg)
Copy button properties
Fields
- title string? - Button label
- 'from record {}? - Copy from
- to record {}? - Copy to
iris.lead: LeadfieldOptionsDropdown![](/images/permalink.svg)
Add new list item
Fields
- 'key string? - Key
- value string? - Value
iris.lead: LeadfieldOptionsZipcodeAutocomplete![](/images/permalink.svg)
ZIP Code autofill properties
Fields
- city record {}? - City fields
- state record {}? - State fields
- zipcode record {}? - Zipcode fields
iris.lead: LeadFieldOrder![](/images/permalink.svg)
Fields
- value int - New order position of lead field
- 'type string? - Type of changing order position
iris.lead: LeadFieldTab![](/images/permalink.svg)
Fields
- id int? - Tab Id
- active int? - Active tab
- position int - Tab position
- 'class string - Tab class
- name string - Tab class
- 'order int - Tab order
iris.lead: LeadidAppointmentsBody![](/images/permalink.svg)
Fields
- date string - Date in format ISO 8601 (Y-m-d\TH:i:sP)
- date_end string - End date in format ISO 8601 (Y-m-d\TH:i:sP)
- text string - Task description
- set_by string - Task set by user (User Id)
- set_for string - Task set for user (User Id)
iris.lead: LeadidNotesBody![](/images/permalink.svg)
Fields
- tab int - Tab Id
- note string - Note text
- sticky string - Pin to top?
iris.lead: LeadidTasksBody![](/images/permalink.svg)
Fields
- priority string - Priority
- date string - Date in ISO 8601 format (Y-m-d\TH:i:sP)
- date_end string - End date in ISO 8601 format (Y-m-d\TH:i:sP)
- text string - Task description
- set_by string - Task set by user (user Id)
- set_for string - Task set for user (user Id)
iris.lead: LeadidUsersBody![](/images/permalink.svg)
Fields
- user int - User Id
iris.lead: LeadsFieldsBody![](/images/permalink.svg)
Fields
- Fields Included from *LeadField
- override boolean? - Flag for overriding existing special field
iris.lead: LeadsLeadidBody![](/images/permalink.svg)
Fields
- campaign int? - Campaign Id
- status int? - Status Id
- 'source int? - Source Id
- 'group int? - Group Id
- fields Apiv1leadsFields[]? - Lead fields
iris.lead: Links![](/images/permalink.svg)
Fields
- first string? - An URL to the first page of the data set
- last string? - An URL to the last page of the data set
- prev string? - An URL to the previous page of the data set
- next string? - An URL to the next page of the data set
iris.lead: LinksActivity![](/images/permalink.svg)
Fields
- id int? - Activity Id
- status string? - Status of link
- lead string? - Lead Id
- merchant string? - Merchant Id
- linkedBy int? - User Id
- linkedAt string? - Linking date (Y-m-d\TH:i:sP)
iris.lead: Meta![](/images/permalink.svg)
Fields
- current_page int? - The current page number of a data set
- 'from int? - The current position of a data set
- last_page string? - The last page of a data set
- path string? - API path
- per_page int? - A number of records per page
- to int? - The last position in a data set
- total int? - Total number of records in a data set
iris.lead: SourceActivity![](/images/permalink.svg)
Fields
- id int? - Activity Id
- newValue string? - New value of activity
- assignedBy int? - User Id
- assignedAt string? - Assigned date (Y-m-d\TH:i:sP)
iris.lead: StatusActivity![](/images/permalink.svg)
Fields
- id int? - Activity Id
- changedBy int? - User Id
- changedAt string? - Deleted date (Y-m-d\TH:i:sP)
- oldStatus string? - Old status
- old_status_id int? - Old Status Id
- newStatus string? - New status
- new_status_id int? - New Status Id
iris.lead: V1LeadsBody![](/images/permalink.svg)
Fields
- campaign int? - Campaign Id
- status int - Status Id
- 'source int? - Source Id
- 'group int? - Group Id
- users int[]? - Ids of users to assign to a new lead
- fields Apiv1leadsFields[] - Lead fields
Union types![](/images/permalink.svg)
Import
import ballerinax/iris.lead;
Metadata
Released date: over 1 year ago
Version: 1.3.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Paid
Contributors
Dependencies