LeadDesk

LeadDesk offers cloud service for high-volume sales and customer-service. LeadDesk helps contact center agents close more by connecting the right person, with the right offer, through the right channel at the right time. Connect to LeadDesk and perform various actions to manage your leads, contacts and agents.

Status: Preview

Tier: Premium

Version: 1.0.0

Actions:

Name	Summary
AgentCampaignAccess ([internal]string mod, [internal]string cmd, integer agent_id, integer campaign_id, string type)	Agent Campaign Access
CreateAgent ([internal]string mod, [internal]string cmd, CreateAgentParameterBody body)	Create an Agent
CreateCallback ([internal]string mod, [internal]string cmd, CreateCallbackParameterBody body)	Create a Callback
CreateContact ([internal]string mod, [internal]string cmd, [Optional]string fname, [Optional]string lname, string phone, string list, [internal]string return_value, [Optional]string email, [advanced][Optional]string www, [Optional]string address, [Optional]string postcode, [Optional]string city, [Optional]string country, [advanced][Optional]string ssc, [advanced][Optional]string birthyear, [advanced][Optional]string gender, [advanced][Optional]string companyid, [advanced][Optional]string company, [advanced][Optional]string vatin, [advanced][Optional]string title, [advanced][Optional]string comment, [advanced][Optional]string other1, [advanced][Optional]string other2, [advanced][Optional]string other3, [advanced][Optional]string other4, [advanced][Optional]string other5, [advanced][Optional]string other6, [advanced][Optional]string other7, [advanced][Optional]string other8, [advanced][Optional]string other9, [advanced][Optional]string other10, [advanced][Optional]string other11, [advanced][Optional]string other12, [advanced][Optional]string other13, [advanced][Optional]string other14, [advanced][Optional]string other15, [advanced][Optional]string other16, [advanced][Optional]string other17, [advanced][Optional]string other18, [advanced][Optional]string other19, [advanced][Optional]string other20, [advanced][Optional]string other21, [advanced][Optional]string other22, [advanced][Optional]string other23, [advanced][Optional]string other24, [advanced][Optional]string other25, [advanced][Optional]string other26, [advanced][Optional]string other27, [advanced][Optional]string other28, [advanced][Optional]string other29, [advanced][Optional]string other30, [advanced][Optional]string other31, [advanced][Optional]string other32, [advanced][Optional]string other33, [advanced][Optional]string other34, [advanced][Optional]string other35, [advanced][Optional]string assign_to_agent)	Create a Contact
FindAgent ([internal]string mod, [internal]string cmd, string username)	Find an Agent
FindContact ([internal]string mod, [internal]string cmd, [Optional]string fname, [Optional]string lname, [Optional]integer phone, [Optional]integer contact_list_id)	Find a Contact
ModifyAgent ([internal]string mod, [internal]string cmd, ModifyAgentParameterBody body)	Modify an Agent
ModifyContact ([internal]string mod, [internal]string cmd, integer contact_id, [Optional]string fname, [Optional]string lname, [Optional]string phone, [advanced][Optional]string birthyear, [advanced][Optional]string gender, [Optional]string email, [advanced][Optional]string www, [Optional]string address, [Optional]string postcode, [Optional]string city, [Optional]string country, [advanced][Optional]string ssc, [advanced][Optional]integer companyid, [advanced][Optional]string company, [advanced][Optional]string vatin, [advanced][Optional]string title, [advanced][Optional]string comment, [advanced][Optional]string other1, [advanced][Optional]string other2, [advanced][Optional]string other3, [advanced][Optional]string other4, [advanced][Optional]string other5, [advanced][Optional]string other6, [advanced][Optional]string other7, [advanced][Optional]string other8, [advanced][Optional]string other9, [advanced][Optional]string other10, [advanced][Optional]string other11, [advanced][Optional]string other12, [advanced][Optional]string other13, [advanced][Optional]string other14, [advanced][Optional]string other15, [advanced][Optional]string other16, [advanced][Optional]string other17, [advanced][Optional]string other18, [advanced][Optional]string other19, [advanced][Optional]string other20, [advanced][Optional]string other21, [advanced][Optional]string other22, [advanced][Optional]string other23, [advanced][Optional]string other24, [advanced][Optional]string other25, [advanced][Optional]string other26, [advanced][Optional]string other27, [advanced][Optional]string other28, [advanced][Optional]string other29, [advanced][Optional]string other30, [advanced][Optional]string other31, [advanced][Optional]string other32, [advanced][Optional]string other33, [advanced][Optional]string other34, [advanced][Optional]string other35, [Optional]string list, [advanced][Optional]string order, [advanced][Optional]string assign_to_agent)	Modify a Contact

Triggers:

Name

Summary

Objects:

Name	Summary
AgentCampaignAccessResponse
CreateAgentParameterBody
CreateAgentResponse
CreateCallbackParameterBody
CreateCallbackResponse
CreateContactResponse
FindAgentResponse
FindContactResponse
ModifyAgentParameterBody
ModifyAgentResponse
ModifyContactResponse

Actions:

AgentCampaignAccess

Summary: Agent Campaign Access

Description: This operation edits an agent's campaign access rights.

Syntax:

LeadDesk.AgentCampaignAccess ([internal]string mod, [internal]string cmd, integer agent_id, integer campaign_id, string type)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
agent_id	integer(int64) (Agent ID)	Agent's LeadDesk ID	True
campaign_id	integer(int64) (Campaign ID)	Campaign's LeadDesk ID	True
type	string (Action)Values: [add, remove]	Add or remove the agent from the campaign	True

Returns:

Type:AgentCampaignAccessResponse

CreateAgent

Summary: Create an Agent

Description: This operation creates a new agent.

Syntax:

LeadDesk.CreateAgent ([internal]string mod, [internal]string cmd, CreateAgentParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
body	CreateAgentParameterBody		True

Returns:

Type:CreateAgentResponse

CreateCallback

Summary: Create a Callback

Description: This operation creates a new public or private callback.

Syntax:

LeadDesk.CreateCallback ([internal]string mod, [internal]string cmd, CreateCallbackParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
body	CreateCallbackParameterBody		True

Returns:

Type:CreateCallbackResponse

CreateContact

Summary: Create a Contact

Description: This operation creates a new contact in a calling list.

Syntax:

LeadDesk.CreateContact ([internal]string mod, [internal]string cmd, [Optional]string fname, [Optional]string lname, string phone, string list, [internal]string return_value, [Optional]string email, [advanced][Optional]string www, [Optional]string address, [Optional]string postcode, [Optional]string city, [Optional]string country, [advanced][Optional]string ssc, [advanced][Optional]string birthyear, [advanced][Optional]string gender, [advanced][Optional]string companyid, [advanced][Optional]string company, [advanced][Optional]string vatin, [advanced][Optional]string title, [advanced][Optional]string comment, [advanced][Optional]string other1, [advanced][Optional]string other2, [advanced][Optional]string other3, [advanced][Optional]string other4, [advanced][Optional]string other5, [advanced][Optional]string other6, [advanced][Optional]string other7, [advanced][Optional]string other8, [advanced][Optional]string other9, [advanced][Optional]string other10, [advanced][Optional]string other11, [advanced][Optional]string other12, [advanced][Optional]string other13, [advanced][Optional]string other14, [advanced][Optional]string other15, [advanced][Optional]string other16, [advanced][Optional]string other17, [advanced][Optional]string other18, [advanced][Optional]string other19, [advanced][Optional]string other20, [advanced][Optional]string other21, [advanced][Optional]string other22, [advanced][Optional]string other23, [advanced][Optional]string other24, [advanced][Optional]string other25, [advanced][Optional]string other26, [advanced][Optional]string other27, [advanced][Optional]string other28, [advanced][Optional]string other29, [advanced][Optional]string other30, [advanced][Optional]string other31, [advanced][Optional]string other32, [advanced][Optional]string other33, [advanced][Optional]string other34, [advanced][Optional]string other35, [advanced][Optional]string assign_to_agent)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
fname	string (First name)	Contact's first name	False
lname	string (Last name)	Contact's last name	False
phone	string (Phone number)	Contact's phone number	True
list	string (Calling list name)	Contact's LeadDesk calling list name	True
return_value	string		True
email	string (E-mail)	Contact's email address	False
www	string (Website)	Contact's website	False
address	string (Address)	Contact's street address	False
postcode	string (Postal code)	Contact's postal code	False
city	string (City)	Contact's city	False
country	string (Country)	Contact's country	False
ssc	string (Social security code)	Contact's SSC	False
birthyear	string (Birth year)	Contact's birth year	False
gender	string (Gender)	Contact's gender	False
companyid	string (Company ID)	Contact's company LeadDesk ID	False
company	string (Company name)	Contact's company name	False
vatin	string (VAT number)	Contact's VAT number	False
title	string (Title)	Contact's title	False
comment	string (Comment)	Contact's comment	False
other1	string (Other information 1)	Other information 1	False
other2	string (Other information 2)	Other information 2	False
other3	string (Other information 3)	Other information 3	False
other4	string (Other information 4)	Other information 4	False
other5	string (Other information 5)	Other information 5	False
other6	string (Other information 6)	Other information 6	False
other7	string (Other information 7)	Other information 7	False
other8	string (Other information 8)	Other information 8	False
other9	string (Other information 9)	Other information 9	False
other10	string (Other information 10)	Other information 10	False
other11	string (Other information 11)	Other information 11	False
other12	string (Other information 12)	Other information 12	False
other13	string (Other information 13)	Other information 13	False
other14	string (Other information 14)	Other information 14	False
other15	string (Other information 15)	Other information 15	False
other16	string (Other information 16)	Other information 16	False
other17	string (Other information 17)	Other information 17	False
other18	string (Other information 18)	Other information 18	False
other19	string (Other information 19)	Other information 19	False
other20	string (Other information 20)	Other information 20	False
other21	string (Other information 21)	Other information 21	False
other22	string (Other information 22)	Other information 22	False
other23	string (Other information 23)	Other information 23	False
other24	string (Other information 24)	Other information 24	False
other25	string (Other information 25)	Other information 25	False
other26	string (Other information 26)	Other information 26	False
other27	string (Other information 27)	Other information 27	False
other28	string (Other information 28)	Other information 28	False
other29	string (Other information 29)	Other information 29	False
other30	string (Other information 30)	Other information 30	False
other31	string (Other information 31)	Other information 31	False
other32	string (Other information 32)	Other information 32	False
other33	string (Other information 33)	Other information 33	False
other34	string (Other information 34)	Other information 34	False
other35	string (Other information 35)	Other information 35	False
assign_to_agent	string (Assign to agent)	ID or username	False

Returns:

Type:CreateContactResponse

FindAgent

Summary: Find an Agent

Description: This operation finds an agent's name and ID based on their username.

Syntax:

LeadDesk.FindAgent ([internal]string mod, [internal]string cmd, string username)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
username	string (Agent username)	Agent's LeadDesk username	True

Returns:

Type:FindAgentResponse

FindContact

Summary: Find a Contact

Description: This operation gets a list of contact IDs fitting the given information.

Syntax:

LeadDesk.FindContact ([internal]string mod, [internal]string cmd, [Optional]string fname, [Optional]string lname, [Optional]integer phone, [Optional]integer contact_list_id)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
fname	string (First name)	Contact's first name	False
lname	string (Last name)	Contact's last name	False
phone	integer (Phone number)	Contact's phone number	False
contact_list_id	integer (Contact list ID)	Contact's LeadDesk list ID	False

Returns:

Type:FindContactResponse

ModifyAgent

Summary: Modify an Agent

Description: This operation edits an agent's personal and work related information.

Syntax:

LeadDesk.ModifyAgent ([internal]string mod, [internal]string cmd, ModifyAgentParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
body	ModifyAgentParameterBody		True

Returns:

Type:ModifyAgentResponse

ModifyContact

Summary: Modify a Contact

Description: This operation edits a contact's information.

Syntax:

LeadDesk.ModifyContact ([internal]string mod, [internal]string cmd, integer contact_id, [Optional]string fname, [Optional]string lname, [Optional]string phone, [advanced][Optional]string birthyear, [advanced][Optional]string gender, [Optional]string email, [advanced][Optional]string www, [Optional]string address, [Optional]string postcode, [Optional]string city, [Optional]string country, [advanced][Optional]string ssc, [advanced][Optional]integer companyid, [advanced][Optional]string company, [advanced][Optional]string vatin, [advanced][Optional]string title, [advanced][Optional]string comment, [advanced][Optional]string other1, [advanced][Optional]string other2, [advanced][Optional]string other3, [advanced][Optional]string other4, [advanced][Optional]string other5, [advanced][Optional]string other6, [advanced][Optional]string other7, [advanced][Optional]string other8, [advanced][Optional]string other9, [advanced][Optional]string other10, [advanced][Optional]string other11, [advanced][Optional]string other12, [advanced][Optional]string other13, [advanced][Optional]string other14, [advanced][Optional]string other15, [advanced][Optional]string other16, [advanced][Optional]string other17, [advanced][Optional]string other18, [advanced][Optional]string other19, [advanced][Optional]string other20, [advanced][Optional]string other21, [advanced][Optional]string other22, [advanced][Optional]string other23, [advanced][Optional]string other24, [advanced][Optional]string other25, [advanced][Optional]string other26, [advanced][Optional]string other27, [advanced][Optional]string other28, [advanced][Optional]string other29, [advanced][Optional]string other30, [advanced][Optional]string other31, [advanced][Optional]string other32, [advanced][Optional]string other33, [advanced][Optional]string other34, [advanced][Optional]string other35, [Optional]string list, [advanced][Optional]string order, [advanced][Optional]string assign_to_agent)

Parameters:

Name	Type	Summary	Required	Related Action
mod	string		True
cmd	string		True
contact_id	integer(int64) (Contact ID)	Contact's LeadDesk ID	True
fname	string (First name)	Contact's first name	False
lname	string (Last name)	Contact's last name	False
phone	string (Phone number)	Contact's phone number	False
birthyear	string (Birth year)	Contact's birth year	False
gender	string (Gender)	Contact's gender	False
email	string (E-mail)	Contact's email address	False
www	string (Website)	Contact's website	False
address	string (Address)	Contact's street address	False
postcode	string (Postal code)	Contact's postal code	False
city	string (City)	Contact's city	False
country	string (Country)	Contact's country	False
ssc	string (Social security code)	Contact's SSC	False
companyid	integer(int64) (Company ID)	Contact's company LeadDesk ID	False
company	string (Company name)	Contact's company name	False
vatin	string (VAT number)	Contact's VAT number	False
title	string (Title)	Contact's title	False
comment	string (Comment)	Contact's comment	False
other1	string (Other information 1)	Other information 1	False
other2	string (Other information 2)	Other information 2	False
other3	string (Other information 3)	Other information 3	False
other4	string (Other information 4)	Other information 4	False
other5	string (Other information 5)	Other information 5	False
other6	string (Other information 6)	Other information 6	False
other7	string (Other information 7)	Other information 7	False
other8	string (Other information 8)	Other information 8	False
other9	string (Other information 9)	Other information 9	False
other10	string (Other information 10)	Other information 10	False
other11	string (Other information 11)	Other information 11	False
other12	string (Other information 12)	Other information 12	False
other13	string (Other information 13)	Other information 13	False
other14	string (Other information 14)	Other information 14	False
other15	string (Other information 15)	Other information 15	False
other16	string (Other information 16)	Other information 16	False
other17	string (Other information 17)	Other information 17	False
other18	string (Other information 18)	Other information 18	False
other19	string (Other information 19)	Other information 19	False
other20	string (Other information 20)	Other information 20	False
other21	string (Other information 21)	Other information 21	False
other22	string (Other information 22)	Other information 22	False
other23	string (Other information 23)	Other information 23	False
other24	string (Other information 24)	Other information 24	False
other25	string (Other information 25)	Other information 25	False
other26	string (Other information 26)	Other information 26	False
other27	string (Other information 27)	Other information 27	False
other28	string (Other information 28)	Other information 28	False
other29	string (Other information 29)	Other information 29	False
other30	string (Other information 30)	Other information 30	False
other31	string (Other information 31)	Other information 31	False
other32	string (Other information 32)	Other information 32	False
other33	string (Other information 33)	Other information 33	False
other34	string (Other information 34)	Other information 34	False
other35	string (Other information 35)	Other information 35	False
list	string (Calling list ID or name)	Calling list's LeadDesk ID or name	False
order	string (Order in the list)Values: [first, last]	Order in the list	False
assign_to_agent	string (Assign to agent)	Agent's ID or username	False

Returns:

Type:ModifyContactResponse

AgentCampaignAccessResponse

Summary:

Description:

Properties:

Name

Type

Summary

success

boolean

success Values: [, ]

CreateAgentParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
account	Account	account
contact_information	Contact_information	contact_information
employment	Employment	employment

Account

Summary:

Description: account

Properties:

Name	Type	Summary
external_id	string	Agent's external ID
inbound_number	string	Agent's inbound phone number
lang	string(int32)	1: EN, 4: FI, 5: SE, 7: DE, 14: NO, 17: DK, 23: NL
level	string	level
password	string	Agent's password
time_zone	string	Agent's time zone
username	string	Agent's username
voip_username	string	Agent's VOIP username

Contact_information

Summary:

Description: contact_information

Properties:

Name	Type	Summary
address	string	Agent's street address
city	string	Agent's city
country	string	Agent's country
e_contacts	string	Agent's emergency contact
email	string	Agent's email address
name	string	Agent's name
phone	string	Agent's phone number
postal	string	Agent's postal code
workphone	string	Agent's work phone number

Employment

Summary:

Description: employment

Properties:

Name	Type	Summary
agent_group_id	integer(int32)	Agent's group LeadDesk ID
bank_acc	string	Agent's bank account
description	string	Agent's description
employment	string	Agent's employment status Values: [active, inactive]
employment_start	string(date)	Format: 2019-12-31
office	string	Agent's office name
ssn	string	Agent's SSN
workshift	string	Agent's work shift

CreateAgentResponse

Summary:

Description:

Properties:

Name

Type

Summary

integer(int64)

success

boolean

success Values: [, ]

CreateCallbackParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
contact	Contact	contact
properties	Properties	properties
return_callback_id	boolean	return_callback_id

Contact

Summary:

Description: contact

Properties:

Name	Type	Summary
address	string	Contact's street address
city	string	Contact's city
companyid	integer(int32)	Contact's company LeadDesk ID
contact_list	string	Contact's LeadDesk contact list name
contactid	string	If set, other given contact values will be ignored
country	string	Contact's country
fname	string	Contact's first name
lname	string	Contact's last name
other1	string	Other information 1
other2	string	Other information 2
other3	string	Other information 3
other4	string	Other information 4
other5	string	Other information 5
other6	string	Other information 6
other7	string	Other information 7
other8	string	Other information 8
other9	string	Other information 9
other10	string	Other information 10
other11	string	Other information 11
other12	string	Other information 12
other13	string	Other information 13
other14	string	Other information 14
other15	string	Other information 15
other16	string	Other information 16
other17	string	Other information 17
other18	string	Other information 18
other19	string	Other information 19
other20	string	Other information 20
other21	string	Other information 21
other22	string	Other information 22
other23	string	Other information 23
other24	string	Other information 24
other25	string	Other information 25
other26	string	Other information 26
other27	string	Other information 27
other28	string	Other information 28
other29	string	Other information 29
other30	string	Other information 30
other31	string	Other information 31
other32	string	Other information 32
other33	string	Other information 33
other34	string	Other information 34
other35	string	Other information 35
postcode	string	Contact's postcode

Properties

Summary:

Description: properties

Properties:

Name	Type	Summary
agent	string	Agent's LeadDesk username
agent_group	string	Agent's LeadDesk group name
campaign	string	Agent's LeadDesk campaign
comment	string	Callback comment
phone	string	Agent's phone number
timestamp	string	Callback time, Format: YYYY-MM-DD HH:MM:SS
type	string	Callback type Values: [private, public]

CreateCallbackResponse

Summary:

Description:

Properties:

Name

Type

Summary

callback_id

integer(int64)

callback_id

success

boolean

success Values: [, ]

CreateContactResponse

Summary:

Description:

Properties:

Name

Type

Summary

contact_id

integer(int32)

contact_id

success

boolean

success Values: [, ]

FindAgentResponse

Summary:

Description:

Properties:

Name

Type

Summary

integer(int64)

name

string

name

FindContactResponse

Summary:

Description:

Properties:

Name	Type	Summary
contact_ids	array of (integer(int32))	contact_ids
success	boolean	success Values: [, ]
total_count	integer(int32)	total_count

ModifyAgentParameterBody

Summary:

Description:

Properties:

Name	Type	Summary
account	Account	account
contact_information	Contact_information	contact_information
disable	boolean	Disable the agent Values: [, ]
employment	Employment	employment
id	integer(int64)	Agent's LeadDesk ID

Account

Summary:

Description: account

Properties:

Name	Type	Summary
external_id	string	Agent's external ID
inbound_number	string	Agent's inbound phone number
lang	integer(int32)	1: EN, 3: EE, 4: FI, 5: SE, 7: DE, 8: HU, 9: RO, 10: ES, 11: PL, 12: CZ, 13: SK, 14: NO, 15: RU, 17: DK
password	string	Agent's password
time_zone	string	e.g.: Europe/Helsinki
username	string	Agent's username
voip_username	string	Agent's VOIP username

Contact_information

Summary:

Description: contact_information

Properties:

Name	Type	Summary
address	string	Agent's street address
city	string	Agent's city
country	string	Agent's country
e_contacts	string	Agent's emergency contact
email	string	Agent's email address
name	string	Agent's name
phone	string	Agent's phone number
postal	string	Agent's postal code
workphone	string	Agent's work phone number

Employment

Summary:

Description: employment

Properties:

Name	Type	Summary
agent_group_id	integer(int32)	Agent's LeadDesk group ID
bank_acc	string	Agent's bank account
description	string	Agent's description
employment	string	Agent's employment status Values: [, active, inactive]
employment_start	string	Format: 2019-12-31
office	string	Agent's office name
ssn	string	Agent's SSN
workshift	string	Agent's work shift

ModifyAgentResponse

Summary:

Description:

Properties:

Name

Type

Summary

success

boolean

success Values: [, ]

ModifyContactResponse

Summary:

Description:

Properties:

Name

Type

Summary

message

string

Contact modified

success

boolean

success Values: [, ]