Difference between revisions of "API"

From docs
Jump to: navigation, search
(Created page with " == API ==")
 
(→‎People)
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
 
== API ==
 
== API ==
 +
 +
The CallProof API can be used to automate backend workflows.
 +
 +
 +
=== API Keys ===
 +
::[[Create API Keys|How to Create API Keys]]
 +
 +
 +
=== API Ping ===
 +
 +
API Ping:
 +
::[[API:Ping|https://app.callproof.com/api/ping/]]
 +
 +
 +
=== Reps ===
 +
 +
Update Reps Stats HTML:
 +
::[[API:Reps:Stats:HTML:Update|https://app.callproof.com/api/reps/stats/html/update/]]
 +
 +
Delete Reps Stats HTML:
 +
::[[API:Reps:Stats:HTML:Delete|https://app.callproof.com/api/reps/stats/html/delete/]]
 +
 +
Get Reps:
 +
::[[API:Reps:Get|https://app.callproof.com/api/reps/get/]]
 +
 +
 +
=== App Stats ===
 +
 +
Created Company Notes:
 +
::[[API:Companies:Notes:Created|https://app.callproof.com/api/companies/notes/created/]]
 +
 +
Update Company Stats HTML:
 +
::[[API:Companies:Stats:HTML:Update|https://app.callproof.com/api/companies/stats/html/update/]]
 +
 +
Delete Company Stats HTML:
 +
::[[API:Companies:Stats:HTML:Delete|https://app.callproof.com/api/companies/stats/html/delete/]]
 +
 +
=== Contacts ===
 +
 +
Created Contacts:
 +
::[[API:Contacts:Created|https://app.callproof.com/api/contacts/created/]]
 +
 +
Updated Contacts:
 +
::[[API:Contacts:Updated|https://app.callproof.com/api/contacts/updated/]]
 +
 +
Find Contacts:
 +
::[[API:Contacts:Find|https://app.callproof.com/api/contacts/find/]]
 +
 +
Get Contact:
 +
::[[API:Contact:Get|https://app.callproof.com/api/contact/get/]]
 +
 +
Update Contact:
 +
::[[API:Contact:Update|https://app.callproof.com/api/contact/update/]]
 +
 +
Update Contact Reps:
 +
::[[API:Contact:Update:Reps|https://app.callproof.com/api/contact/update/reps/]]
 +
 +
Create Contact:
 +
::[[API:Contact:New|https://app.callproof.com/api/contact/new/]]
 +
 +
Delete Contact:
 +
::[[API:Contact:Delete|https://app.callproof.com/api/contact/delete/]]
 +
 +
Update Contact Custom Fields:
 +
::[[API:Contact:CustomFields:Update|https://app.callproof.com/api/contact/custom_fields/update/]]
 +
 +
Get Contact Files:
 +
::[[API:Contact:Files:Get|https://app.callproof.com/api/contact/files/created/]]
 +
 +
Upload New Contact Files:
 +
::[[API:Contact:Files:New|https://app.callproof.com/api/contact/files/new/]]
 +
 +
Get Contact Images:
 +
::[[API:Contact:Images:Get|https://app.callproof.com/api/contact/images/get/]]
 +
 +
Get Contact Emails Messages:
 +
::[[API:Contact:Email:Get|https://app.callproof.com/api/contact/email/messages/get/]]
 +
 +
New Emails Messages:
 +
::[[API:Email:New|https://app.callproof.com/api/contact/email/messages/new/]]
 +
 +
=== Contact Phones ===
 +
 +
Get Updated Contact Phones:
 +
::[[API:Contact Phones:Updated|https://app.callproof.com/api/contact_phones/updated/]]
 +
 +
Get Contact Phones:
 +
::[[API:ContactPhones:Get|https://app.callproof.com/api/contact_phones/get/]]
 +
 +
Update Contact Phone:
 +
::[[API:ContactPhone:Update|https://app.callproof.com/api/contact_phone/update/]]
 +
 +
Create Contact Phone:
 +
::[[API:ContactPhone:New|https://app.callproof.com/api/contact_phone/new/]]
 +
 +
 +
=== Contact Notes ===
 +
 +
Get Contact Notes:
 +
::[[API:ContactNotes:Get|https://app.callproof.com/api/contact_notes/get/]]
 +
 +
Update Contact Note:
 +
::[[API:ContactNote:Update|https://app.callproof.com/api/contact_note/update/]]
 +
 +
Create Contact Note:
 +
::[[API:ContactNote:New|https://app.callproof.com/api/contact_note/new/]]
 +
 +
Delete Contact Note:
 +
::[[API:ContactNote:Delete|https://app.callproof.com/api/contact_note/delete/]]
 +
 +
 +
=== People ===
 +
 +
Get People:
 +
::[[API:People:Get|https://app.callproof.com/api/contact/personnel/get/<contact_id>/]]
 +
 +
Create Personnel:
 +
::[[API:People:Create|https://app.callproof.com/api/contact/personnel/create/]]
 +
 +
Update Personnel:
 +
::[[API:People:Update|https://app.callproof.com/api/contact/personnel/update/]]
 +
 +
Delete Personnel:
 +
::[[API:People:Delete|https://app.callproof.com/api/contact/personnel/delete/<personnel_id/>]]
 +
 +
Get Personnel contact phones:
 +
::[[API:People:Phones:Get|https://app.callproof.com/api/contact/personnel/phones/get/<personnel_id>/]]
 +
 +
Get People Roles:
 +
::[[API:People:Roles:Get|https://app.callproof.com/api/contact/people/roles/get/]]
 +
 +
=== Calls ===
 +
 +
Created Calls:
 +
::[[API:Calls:Created|https://app.callproof.com/api/calls/created/]]
 +
 +
Calls By ID:
 +
::[[API:Calls:ByID|https://app.callproof.com/api/calls/by_id/]]
 +
 +
Create Call:
 +
::[[API:Call:Create|https://app.callproof.com/api/call/create/]]
 +
 +
=== Appointments ===
 +
 +
Updated Appointments:
 +
::[[API:Appointments:Updated|https://app.callproof.com/api/appts/updated/]]
 +
 +
New Appointment:
 +
::[[API:Appointment:New|https://app.callproof.com/api/appts/new/]]
 +
 +
End Appointment:
 +
::[[API:Appointment:End|https://app.callproof.com/api/appts/end/]]
 +
 +
=== Custom Fields ===
 +
 +
Get Custom Fields:
 +
::[[API:CustomFields:Get|https://app.callproof.com/api/custom_fields/get/]]
 +
 +
Update Custom Field:
 +
::[[API:CustomField:Update|https://app.callproof.com/api/custom_field/update/]]
 +
 +
Create Custom Field:
 +
::[[API:CustomField:Create|https://app.callproof.com/api/custom_field/new/]]
 +
 +
Update Custom Field Option:
 +
::[[API:CustomFieldOption:Update|https://app.callproof.com/api/custom_field/option/update/]]
 +
 +
Create Custom Field Option:
 +
::[[API:CustomFieldOption:Create|https://app.callproof.com/api/custom_field/option/new/]]
 +
 +
=== Companies ===
 +
 +
 +
Create Companies:
 +
::[[API:Companies:Create|https://app.callproof.com/api/companies/new/]]
 +
 +
Update Companies:
 +
::[[API:Companies:Update|https://app.callproof.com/api/companies/update/]]
 +
 +
Delete Companies:
 +
::[[API:Companies:Delete|https://app.callproof.com/api/companies/delete/]]
 +
 +
=== Opportunity ===
 +
 +
 +
Get Opportunity Stages:
 +
::[[API:Opportunity:Stages:Get|https://app.callproof.com/api/opportunity/stages/get/]]
 +
 +
Get Opportunity Type:
 +
::[[API:Opportunity:Type:Get|https://app.callproof.com/api/opportunity/type/get/]]
 +
 +
Get Contact Opportunity:
 +
::[[API:Opportunity:Contact:Get|https://app.callproof.com/api/opportunity/get/]]
 +
 +
Create Opportunity:
 +
::[[API:Opportunity:Create|https://app.callproof.com/api/opportunity/new/]]
 +
 +
=== Followup ===
 +
 +
Updated Followup:
 +
::[[API:Followup:Updated|https://app.callproof.com/api/followup/updated/]]
 +
 +
New Followup:
 +
::[[API:Followup:Create|https://app.callproof.com/api/followup/new/]]
 +
 +
=== Event Forms ===
 +
 +
 +
Get Event Forms:
 +
::[[API:EventForms:Get|https://app.callproof.com/api/event_form/get/]]
 +
 +
Get Contact Event Forms:
 +
::[[API:EventForms:Contact:Get|https://app.callproof.com/api/contact/event_form/get/]]
 +
 +
Get Event Forms Details:
 +
::[[API:EventForms:Details:Get|https://app.callproof.com/api/contact/event_form/details/get/]]
 +
 +
Create Event Form:
 +
::[[API:EventForms:Contact:Create|https://app.callproof.com/api/contact/event_form/create/]]
 +
 +
=== API Errors  ===
 +
 +
We followed standard errors from w3.org.  A link is provided here:  http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Latest revision as of 09:33, 24 May 2019

API

The CallProof API can be used to automate backend workflows.


API Keys

How to Create API Keys


API Ping

API Ping:

https://app.callproof.com/api/ping/


Reps

Update Reps Stats HTML:

https://app.callproof.com/api/reps/stats/html/update/

Delete Reps Stats HTML:

https://app.callproof.com/api/reps/stats/html/delete/

Get Reps:

https://app.callproof.com/api/reps/get/


App Stats

Created Company Notes:

https://app.callproof.com/api/companies/notes/created/

Update Company Stats HTML:

https://app.callproof.com/api/companies/stats/html/update/

Delete Company Stats HTML:

https://app.callproof.com/api/companies/stats/html/delete/

Contacts

Created Contacts:

https://app.callproof.com/api/contacts/created/

Updated Contacts:

https://app.callproof.com/api/contacts/updated/

Find Contacts:

https://app.callproof.com/api/contacts/find/

Get Contact:

https://app.callproof.com/api/contact/get/

Update Contact:

https://app.callproof.com/api/contact/update/

Update Contact Reps:

https://app.callproof.com/api/contact/update/reps/

Create Contact:

https://app.callproof.com/api/contact/new/

Delete Contact:

https://app.callproof.com/api/contact/delete/

Update Contact Custom Fields:

https://app.callproof.com/api/contact/custom_fields/update/

Get Contact Files:

https://app.callproof.com/api/contact/files/created/

Upload New Contact Files:

https://app.callproof.com/api/contact/files/new/

Get Contact Images:

https://app.callproof.com/api/contact/images/get/

Get Contact Emails Messages:

https://app.callproof.com/api/contact/email/messages/get/

New Emails Messages:

https://app.callproof.com/api/contact/email/messages/new/

Contact Phones

Get Updated Contact Phones:

https://app.callproof.com/api/contact_phones/updated/

Get Contact Phones:

https://app.callproof.com/api/contact_phones/get/

Update Contact Phone:

https://app.callproof.com/api/contact_phone/update/

Create Contact Phone:

https://app.callproof.com/api/contact_phone/new/


Contact Notes

Get Contact Notes:

https://app.callproof.com/api/contact_notes/get/

Update Contact Note:

https://app.callproof.com/api/contact_note/update/

Create Contact Note:

https://app.callproof.com/api/contact_note/new/

Delete Contact Note:

https://app.callproof.com/api/contact_note/delete/


People

Get People:

https://app.callproof.com/api/contact/personnel/get/<contact_id>/

Create Personnel:

https://app.callproof.com/api/contact/personnel/create/

Update Personnel:

https://app.callproof.com/api/contact/personnel/update/

Delete Personnel:

https://app.callproof.com/api/contact/personnel/delete/<personnel_id/>

Get Personnel contact phones:

https://app.callproof.com/api/contact/personnel/phones/get/<personnel_id>/

Get People Roles:

https://app.callproof.com/api/contact/people/roles/get/

Calls

Created Calls:

https://app.callproof.com/api/calls/created/

Calls By ID:

https://app.callproof.com/api/calls/by_id/

Create Call:

https://app.callproof.com/api/call/create/

Appointments

Updated Appointments:

https://app.callproof.com/api/appts/updated/

New Appointment:

https://app.callproof.com/api/appts/new/

End Appointment:

https://app.callproof.com/api/appts/end/

Custom Fields

Get Custom Fields:

https://app.callproof.com/api/custom_fields/get/

Update Custom Field:

https://app.callproof.com/api/custom_field/update/

Create Custom Field:

https://app.callproof.com/api/custom_field/new/

Update Custom Field Option:

https://app.callproof.com/api/custom_field/option/update/

Create Custom Field Option:

https://app.callproof.com/api/custom_field/option/new/

Companies

Create Companies:

https://app.callproof.com/api/companies/new/

Update Companies:

https://app.callproof.com/api/companies/update/

Delete Companies:

https://app.callproof.com/api/companies/delete/

Opportunity

Get Opportunity Stages:

https://app.callproof.com/api/opportunity/stages/get/

Get Opportunity Type:

https://app.callproof.com/api/opportunity/type/get/

Get Contact Opportunity:

https://app.callproof.com/api/opportunity/get/

Create Opportunity:

https://app.callproof.com/api/opportunity/new/

Followup

Updated Followup:

https://app.callproof.com/api/followup/updated/

New Followup:

https://app.callproof.com/api/followup/new/

Event Forms

Get Event Forms:

https://app.callproof.com/api/event_form/get/

Get Contact Event Forms:

https://app.callproof.com/api/contact/event_form/get/

Get Event Forms Details:

https://app.callproof.com/api/contact/event_form/details/get/

Create Event Form:

https://app.callproof.com/api/contact/event_form/create/

API Errors

We followed standard errors from w3.org. A link is provided here: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Retrieved from "http://docs.callproof.com/index.php?title=API&oldid=904"