LeadDesk (Preview)

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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

The API Key for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Agent Campaign Access

This operation edits an agent's campaign access rights.

Create a Callback

This operation creates a new public or private callback.

Create a Contact

This operation creates a new contact in a calling list.

Create an Agent

This operation creates a new agent.

Find a Contact

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

Find an Agent

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

Modify a Contact

This operation edits a contact's information.

Modify an Agent

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

Agent Campaign Access

This operation edits an agent's campaign access rights.

Parameters

Name Key Required Type Description
Agent ID
agent_id True integer

Agent's LeadDesk ID

Campaign ID
campaign_id True integer

Campaign's LeadDesk ID

Action
type True string

Add or remove the agent from the campaign

Returns

Name Path Type Description
Success
success boolean

success

Create a Callback

This operation creates a new public or private callback.

Parameters

Name Key Required Type Description
Address
address string

Contact's street address

City
city string

Contact's city

Company ID
companyid integer

Contact's company LeadDesk ID

Contact list name
contact_list string

Contact's LeadDesk contact list name

Contact ID
contactid string

If set, other given contact values will be ignored

Country
country string

Contact's country

First name
fname string

Contact's first name

Last name
lname string

Contact's last name

Other information 1
other1 string

Other information 1

Other information 2
other2 string

Other information 2

Other information 3
other3 string

Other information 3

Other information 4
other4 string

Other information 4

Other information 5
other5 string

Other information 5

Other information 6
other6 string

Other information 6

Other information 7
other7 string

Other information 7

Other information 8
other8 string

Other information 8

Other information 9
other9 string

Other information 9

Other information 10
other10 string

Other information 10

Other information 11
other11 string

Other information 11

Other information 12
other12 string

Other information 12

Other information 13
other13 string

Other information 13

Other information 14
other14 string

Other information 14

Other information 15
other15 string

Other information 15

Other information 16
other16 string

Other information 16

Other information 17
other17 string

Other information 17

Other information 18
other18 string

Other information 18

Other information 19
other19 string

Other information 19

Other information 20
other20 string

Other information 20

Other information 21
other21 string

Other information 21

Other information 22
other22 string

Other information 22

Other information 23
other23 string

Other information 23

Other information 24
other24 string

Other information 24

Other information 25
other25 string

Other information 25

Other information 26
other26 string

Other information 26

Other information 27
other27 string

Other information 27

Other information 28
other28 string

Other information 28

Other information 29
other29 string

Other information 29

Other information 30
other30 string

Other information 30

Other information 31
other31 string

Other information 31

Other information 32
other32 string

Other information 32

Other information 33
other33 string

Other information 33

Other information 34
other34 string

Other information 34

Other information 35
other35 string

Other information 35

Postal code
postcode string

Contact's postcode

Agent username
agent True string

Agent's LeadDesk username

Agent group name
agent_group string

Agent's LeadDesk group name

Campaign name
campaign True string

Agent's LeadDesk campaign

Comment
comment string

Callback comment

Phone number
phone True string

Agent's phone number

Timestamp
timestamp True string

Callback time, Format: YYYY-MM-DD HH:MM:SS

Type
type True string

Callback type

Returns

Name Path Type Description
Callback ID
callback_id integer

callback_id

Success
success boolean

success

Create a Contact

This operation creates a new contact in a calling list.

Parameters

Name Key Required Type Description
First name
fname string

Contact's first name

Last name
lname string

Contact's last name

Phone number
phone True string

Contact's phone number

Calling list name
list True string

Contact's LeadDesk calling list name

E-mail
email string

Contact's email address

Website
www string

Contact's website

Address
address string

Contact's street address

Postal code
postcode string

Contact's postal code

City
city string

Contact's city

Country
country string

Contact's country

Social security code
ssc string

Contact's SSC

Birth year
birthyear string

Contact's birth year

Gender
gender string

Contact's gender

Company ID
companyid string

Contact's company LeadDesk ID

Company name
company string

Contact's company name

VAT number
vatin string

Contact's VAT number

Title
title string

Contact's title

Comment
comment string

Contact's comment

Other information 1
other1 string

Other information 1

Other information 2
other2 string

Other information 2

Other information 3
other3 string

Other information 3

Other information 4
other4 string

Other information 4

Other information 5
other5 string

Other information 5

Other information 6
other6 string

Other information 6

Other information 7
other7 string

Other information 7

Other information 8
other8 string

Other information 8

Other information 9
other9 string

Other information 9

Other information 10
other10 string

Other information 10

Other information 11
other11 string

Other information 11

Other information 12
other12 string

Other information 12

Other information 13
other13 string

Other information 13

Other information 14
other14 string

Other information 14

Other information 15
other15 string

Other information 15

Other information 16
other16 string

Other information 16

Other information 17
other17 string

Other information 17

Other information 18
other18 string

Other information 18

Other information 19
other19 string

Other information 19

Other information 20
other20 string

Other information 20

Other information 21
other21 string

Other information 21

Other information 22
other22 string

Other information 22

Other information 23
other23 string

Other information 23

Other information 24
other24 string

Other information 24

Other information 25
other25 string

Other information 25

Other information 26
other26 string

Other information 26

Other information 27
other27 string

Other information 27

Other information 28
other28 string

Other information 28

Other information 29
other29 string

Other information 29

Other information 30
other30 string

Other information 30

Other information 31
other31 string

Other information 31

Other information 32
other32 string

Other information 32

Other information 33
other33 string

Other information 33

Other information 34
other34 string

Other information 34

Other information 35
other35 string

Other information 35

Assign to agent
assign_to_agent string

ID or username

Returns

Name Path Type Description
Contact ID
contact_id integer

contact_id

Success
success boolean

success

Create an Agent

This operation creates a new agent.

Parameters

Name Key Required Type Description
External ID
external_id string

Agent's external ID

Inbound phone number
inbound_number string

Agent's inbound phone number

Language ID
lang integer

1: EN, 4: FI, 5: SE, 7: DE, 14: NO, 17: DK, 23: NL

Password
password True string

Agent's password

Time zone
time_zone string

Agent's time zone

Username
username True string

Agent's username

VOIP username
voip_username string

Agent's VOIP username

Address
address string

Agent's street address

City
city string

Agent's city

Country
country string

Agent's country

Emergency contact
e_contacts string

Agent's emergency contact

E-mail
email string

Agent's email address

Name
name True string

Agent's name

Phone number
phone string

Agent's phone number

Postal code
postal string

Agent's postal code

Work phone
workphone string

Agent's work phone number

Agent group ID
agent_group_id integer

Agent's group LeadDesk ID

Bank account
bank_acc string

Agent's bank account

Description
description string

Agent's description

Employment status
employment string

Agent's employment status

Employment start date
employment_start date

Format: 2019-12-31

Office name
office string

Agent's office name

Social security number
ssn string

Agent's SSN

Work shift
workshift string

Agent's work shift

Returns

Name Path Type Description
Agent ID
id integer

id

Success
success boolean

success

Find a Contact

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

Parameters

Name Key Required Type Description
First name
fname string

Contact's first name

Last name
lname string

Contact's last name

Phone number
phone integer

Contact's phone number

Contact list ID
contact_list_id integer

Contact's LeadDesk list ID

Returns

Name Path Type Description
contact_ids
contact_ids array of integer

contact_ids

Success
success boolean

success

Total count
total_count integer

total_count

Find an Agent

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

Parameters

Name Key Required Type Description
Agent username
username True string

Agent's LeadDesk username

Returns

Name Path Type Description
Agent ID
id integer

id

Agent name
name string

name

Modify a Contact

This operation edits a contact's information.

Parameters

Name Key Required Type Description
Contact ID
contact_id True integer

Contact's LeadDesk ID

First name
fname string

Contact's first name

Last name
lname string

Contact's last name

Phone number
phone string

Contact's phone number

Birth year
birthyear string

Contact's birth year

Gender
gender string

Contact's gender

E-mail
email string

Contact's email address

Website
www string

Contact's website

Address
address string

Contact's street address

Postal code
postcode string

Contact's postal code

City
city string

Contact's city

Country
country string

Contact's country

Social security code
ssc string

Contact's SSC

Company ID
companyid integer

Contact's company LeadDesk ID

Company name
company string

Contact's company name

VAT number
vatin string

Contact's VAT number

Title
title string

Contact's title

Comment
comment string

Contact's comment

Other information 1
other1 string

Other information 1

Other information 2
other2 string

Other information 2

Other information 3
other3 string

Other information 3

Other information 4
other4 string

Other information 4

Other information 5
other5 string

Other information 5

Other information 6
other6 string

Other information 6

Other information 7
other7 string

Other information 7

Other information 8
other8 string

Other information 8

Other information 9
other9 string

Other information 9

Other information 10
other10 string

Other information 10

Other information 11
other11 string

Other information 11

Other information 12
other12 string

Other information 12

Other information 13
other13 string

Other information 13

Other information 14
other14 string

Other information 14

Other information 15
other15 string

Other information 15

Other information 16
other16 string

Other information 16

Other information 17
other17 string

Other information 17

Other information 18
other18 string

Other information 18

Other information 19
other19 string

Other information 19

Other information 20
other20 string

Other information 20

Other information 21
other21 string

Other information 21

Other information 22
other22 string

Other information 22

Other information 23
other23 string

Other information 23

Other information 24
other24 string

Other information 24

Other information 25
other25 string

Other information 25

Other information 26
other26 string

Other information 26

Other information 27
other27 string

Other information 27

Other information 28
other28 string

Other information 28

Other information 29
other29 string

Other information 29

Other information 30
other30 string

Other information 30

Other information 31
other31 string

Other information 31

Other information 32
other32 string

Other information 32

Other information 33
other33 string

Other information 33

Other information 34
other34 string

Other information 34

Other information 35
other35 string

Other information 35

Calling list ID or name
list string

Calling list's LeadDesk ID or name

Order in the list
order string

Order in the list

Assign to agent
assign_to_agent string

Agent's ID or username

Returns

Name Path Type Description
message string

Contact modified

Success
success boolean

success

Modify an Agent

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

Parameters

Name Key Required Type Description
External ID
external_id string

Agent's external ID

Inbound phone number
inbound_number string

Agent's inbound phone number

Language ID
lang integer

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
password string

Agent's password

Time zone
time_zone string

e.g.: Europe/Helsinki

Username
username string

Agent's username

VOIP username
voip_username string

Agent's VOIP username

Address
address string

Agent's street address

City
city string

Agent's city

Country
country string

Agent's country

Emergency contact
e_contacts string

Agent's emergency contact

E-mail
email string

Agent's email address

Name
name string

Agent's name

Phone number
phone string

Agent's phone number

Postal code
postal string

Agent's postal code

Work phone
workphone string

Agent's work phone number

Disable the agent
disable boolean

Disable the agent

Agent group ID
agent_group_id integer

Agent's LeadDesk group ID

Bank account
bank_acc string

Agent's bank account

Description
description string

Agent's description

Employment status
employment string

Agent's employment status

Employment start date
employment_start string

Format: 2019-12-31

Office name
office string

Agent's office name

Social security number
ssn string

Agent's SSN

Work shift
workshift string

Agent's work shift

Agent ID
id True integer

Agent's LeadDesk ID

Returns

Name Path Type Description
Success
success boolean

success