User manual

FIXDIGITAL

API – Get Leads

Software development ltd

Revision History

Table of Contents

Module brief …………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………….3

Process: Get Leads using Web hook method………………………………………………………………………………………………………………………………………………………………………………………………………………. 3

Stage 1…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… 3

Stage 2…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… 3

Stage 3…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… 4

Result ………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………4

Process: Update lead status or amount using Web hook method……………………………………………………………………………………………………………………………………………………………………………………. 3

Stage 1…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… 3

Stage 2…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… 3

Stage 3…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… 4

Purpose

The purpose of this document is to explain how to use new module

Module brief

This module is used for get leads from Fixdigital system

Process: Get Leads using Web hook method

.Used for: get leads from Fixdigital by filter (campaign, asset or client) ordered by ID descending

Stage 1

.Login into your Fixdigital account

Link: https://www.fixdigital.co.il/login

Stage 2

.Go to profile Zapier Token page and copy token

Link: https://www.fixdigital.co.il/Profile/ApiToken

Stage 3

To get Leads send GET Request on next URL:
https://www.fixdigital.co.il/api/crm/WebHook/GetLeads?api_key={api_key}&projectID={projectID}&projectTypeID={projectTypeID}&clientID={clientID}&channelID={channelID}&offset={offset}&limit={limit}

1) Please replace {api_key} with token from Stage 2
2) Use {offset} and {limit} for paging – replace {offset} with number of records you want to skip and {limit} with count of records you want to get (0 – will return all records, default value is 100)
3) Set up filter. Available one of 3 filters:
       1 ) By Campaign ID – replace {channelID} with Fixdigital Campaign ID
       2) By Digital Asset – replace {projectID} with Digital Asset ID and {projectTypeID} with one of the next values: 1 – WordPress site; 2 – WordPress landing page; 3 – Custom landing page; 4  –                Outer site; 5 – Outer landing page;
        3) By Client ID – replace {clientID} with Fixdigital Client ID
Note: filters priority Campaign ID > Digital Asset > Client ID

If you do not want to use one of the filters, then just remove it or set 0 as value

Swagger file – https://www.fixdigital.co.il/crm/swagger/leads.swagger.json

Swagger UI – https://www.dev.fixdigital.co.il/crm/swagger/html/index.html

Process: Update lead status or amount using Web hook method

Used for: update lead in Fixdigital (status and amount).

Stage 1

Login into your Fixdigital account.

Link: https://www.fixdigital.co.il/login

Stage 2

Go to profile Zapier Token page and copy token.

Link: https://www.fixdigital.co.il/Profile/ApiToken

Stage 3

To update lead send GET Request on next URL:

https://www.fixdigital.co.il/api/crm/WebHook/UpdateLeadStatusOrAmount?api_key={api_key}&leadID={ leadID}&status={leadstatus}&amount={amount}

• Please replace {api_key} with token from Stage 2
• Lead id – fixdigital lead id
• Status – optional , new lead status, available values InProcess = 4, Good = 6, Meeting = 7, SentEstimate = 8, Closed = 9, NotClosed = 10, NotGood = 11
• Amount – lead deal amount

Swagger file – https://www.fixdigital.co.il/crm/swagger/leads.swagger.json

Swagger UI – https://www.dev.fixdigital.co.il/crm/swagger/html/index.html