Skip to content
This repository has been archived by the owner on Dec 14, 2018. It is now read-only.

Updates to the Readme file #17

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updates to the Readme file #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b6cab9
Added "Campaigns" to the list of supported objects
Feb 24, 2016
62aca1a
Fixed broken links
Feb 24, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Object Types & Operations
Support for the following object types:

+ Accounts
+ Campaigns
+ Emails
+ Lists
+ Opportunities
Expand Down Expand Up @@ -86,7 +87,7 @@ p.authenticate()

###Querying Objects

Supported search criteria varies for each object. Check the [official Pardot API documentation](http://developer.pardot.com/kb/api-version-3/introduction-table-of-contents) for supported parameters. Most objects support `limit`, `offset`, `sort_by`, and `sort_order` parameters. PyPardot returns JSON for all API queries.
Supported search criteria varies for each object. Check the [official Pardot API documentation](http://developer.pardot.com/#official-pardot-api-documentation) for supported parameters. Most objects support `limit`, `offset`, `sort_by`, and `sort_order` parameters. PyPardot returns JSON for all API queries.

**Note**: Pardot only returns 200 records with each request. Use `offset` to retrieve matching records beyond this limit.

Expand All @@ -100,7 +101,7 @@ for prospect in prospects['prospect']

### Editing/Updating/Reading Objects

Supported fields varies for each object. Check the [official Pardot API documentation](http://developer.pardot.com/kb/api-version-3/introduction-table-of-contents) to see the fields associated with each object.
Supported fields varies for each object. Check the [official Pardot API documentation](http://developer.pardot.com/kb/object-field-references/) to see the fields associated with each object.

```
# Create a new prospect
Expand Down Expand Up @@ -130,7 +131,7 @@ Pardot API keys expire after 60 minutes. If PyPardot detects an 'Invalid API key

#### Invalid API parameters

If an API call is made with missing or invalid parameters, a `PardotAPIError` is thrown. Error instances contain the error code and message corresponding to error response returned by the API. See [Pardot Error Codes & Messages](http://developer.pardot.com/kb/api-version-3/error-codes-and-messages) in the official documentation.
If an API call is made with missing or invalid parameters, a `PardotAPIError` is thrown. Error instances contain the error code and message corresponding to error response returned by the API. See [Pardot Error Codes & Messages](http://developer.pardot.com/kb/error-codes-messages/) in the official documentation.

Performing API calls is inherently unsafe, so be sure to catch exceptions:

Expand Down