ProLine Open API

Endpoints and authentication documentation

ProLine API Overview

The ProLine open API provides developers the opportunity to create independent integrations with ProLine.

Base URL

All calls use the following base URL: https://proline.app/api/1.1/wf/

Authentication

We use an API key delivered via query string to authenticate calls.

Please include (?api_key=[proline_api_key]) with all calls made using our open API to authenticate.

You can retrieve the API for a ProLine account by going to Menu > Integrations > API Credentials

We currently support only a single key per ProLine account. ProLine account owners can reset this key if they believe it has been compromised. If a key is reset, then all integrations with the account associated with the old key will need to be updated to the new key.

API Endpoints

Endpoint: https://proline.app/api/1.1/wf/find_contact

Method: POST

JSON Form-Data

REQUIRED PARAMETERS:

api_key
(query string parameter)

OPTIONAL PARAMETERS

contact_id

contact_phone

contact_email

contact_address1
contact_address2
contact_city
contact_state
contact_zip

ProLine will first try to find a contact based on the provided id. If no contact is found for the id, then ProLine will find a contact that matches the phone. If no contact is found for either id or phone, then ProLine will try to find a contact that matches the provided email. If no contact is found for the provided id, phone, or email, then ProLine will try to find a contact that matches the provided address.

ProLine will return a single contact, but there may be multiple contacts found for emails or addresses. The most recently created contact will be returned if multiple contacts are found.

If no contacts are found for any provided data, then nothing is returned.

Empty parameters are always ignored in this search. 

Endpoint: https://proline.app/api/1.1/wf/find_team_member

Method: POST

JSON Form-Data

REQUIRED PARAMETERS:

api_key
(query string parameter)

OPTIONAL PARAMETERS

proline_number

user_email

display_name

ProLine will first try to find a team member based on the provided ProLine number. If no team member is fround for the ProLine number, then ProLine will try to find a team member based on the user account email associated with them. If no team member if found for the ProLine number or user email, then ProLine will try and find a team member based on the provided display name.

The provided display name and the team member’s display name must have the exact same spelling in order to successfully match, but casing is ignored. A match will still occur even if the team member’s display name has different capitalization from the provided display name.

Endpoint: https://proline.app/api/1.1/wf/edit_contact

Method: POST

JSON Form-Data

REQUIRED PARAMETERS:

api_key
(query string parameter)

contact_fname
(The contact’s first name)

OPTIONAL PARAMETERS:

contact_id
(Required if editing a contact. Contact will be created if this field is empty)

contact_phone
(The contact’s 10-digit phone number. All common formats accepted.)

contact_lname
(The contact’s last name)

contact_organization
(The contact’s organization)

contact_email
(The contact’s email)

contact_notes
(The contact’s notes. Replaces all existing notes.)

contact_folder
(The contact’s pipeline. Defaults to owner’s default pipeline)

contact_campaign
(The contact’s stage. Defaults to first stage in pipeline)

contact_optin
(“Yes” or “No”. The contact’s optin status for both phone and email. Defualts to “Yes”)

contact_auto
(“Yes” or “No”. Turns automated messages on or off regardless of optin status. Defaults to “Yes”)

contact_address1
(The contact’s address line 1)

contact_address2
(The contact’s address line 2)

contact_city
(The contact’s city)

contact_state
(The contact’s state as a two-letter abbreviation)

contact_zip
(The contact’s 5-digit zip code)

contact_addonly
(“Yes” or “No”. Turn on to not update existing contacts. Call does nothing if an existing contact is found.)

contact_assign
(The user id of the user on your company’s team that should be assigned to this contact. Defaults to company owner for new contacts and defaults to whoever is already assigned to existing contacts)

custom_field_1
(Parameter for the contact’s first custom field)

custom_field_2
(Parameter for the contact’s second custom field)

custom_field_3
(Parameter for the contact’s third custom field)

custom_date_1
(Accepts ISO dates and store’s it in the contact’s first custom date field)

custom_date_2
(Accepts ISO dates and store’s it in the contact’s second custom date field)

custom_date_3
(Accepts ISO dates and store’s it in the contact’s third custom date field)

external_id
(Parameter for the contact’s external id field. This is a hidden field used to help integrate with other platforms by storing their contact ID in ProLine)

contact_campaign_id
(The unique id of the stage in ProLine that the contact should be moved to)

Endpoint: https://proline.app/api/1.1/wf/activity_alert

Method: POST

JSON Form-Data

REQUIRED PARAMETERS:

api_key
(query string parameter)

contact_id
(Unique id of the contact to create the alert activity for)

alert_text
(The text body of the alert as it will appear in the activty hub for the contact)

Endpoint: https://proline.app/api/1.1/wf/create_webhook

Method: POST

JSON Form-Data

REQUIRED PARAMETERS:

api_key
(query string parameter)

hook_url
(the Url to send the webhook to)

OPTIONAL PARAMETERS

trigger_on

(Possible values:

  • created_or_updated
  • created_only
  • updated_only
  • all_communication
  • message
  • call
  • email
  • email_open

Defaults to “created_or_updated”)

Once registered, a webhook payload will be sent to the url when the selected trigger occurs.

Note: Only one webhook per ProLine company account per URL. If you need to create multiple webhooks for different triggers, use multiple URLs.

DELETE WEBHOOK

Endpoint: https://proline.app/api/1.1/wf/delete_webhook

Method: POST

JSON Form-Data

REQUIRED PARAMETERS:

api_key
(query string parameter)

hook_url


This will delete ALL webhooks with the provided webhook URL for the account associated with the API key.