Contacts

Contacts represent real persons in your CRM database.

get

Paginated list of all Contacts.

post

Add a new Contact.

get

Contact details.

put

Update a Contact's basic information.

get

List of all Addresses. There is always at least 1 correspondence address.

post

Create a new Address. Requires a valid AddressType.

put

Update an Address.

delete

Delete an Address. The default address cannot be deleted.

post

Add a secondary EmailAddress to a Contact.

put

Update a secondary EmailAddress.

delete

Delete an EmailAddress

post

Add an Education to a Contact.

put

Update an Education.

delete

Delete an Education.

post

Add a CompanyPosition to a Contact.

put

Update a CompanyPosition.

delete

Delete an Education

post

Create a new CustomField value for this contact. Note: you can't add two values for one CustomField for the same contact. Use the appropriate *_value, based on CustomField.field_type.

put

Update a CustomFieldValue

get

List of Contact's positions

CustomFieldCategory objects are used to group CustomField objects.

get

List of all CustomFieldCategory objects of Contacts.

CustomFields are used for account-specific data fields.

get

List of all CustomField objects of Contacts.

Segments are a subset of Contacts based on one or multiple rules.

get

Paginated list all Contacts in this Segment.

Organisations

Organisations represent companies in your CRM database.

get

Paginated list of all Organisations.

get

Organisation details.

get

List of all Addresses. There is always at least 1 correspondence address.

post

Create a new Address. Requires a valid AddressType.

put

Update an Address.

delete

Delete an Address. The default address cannot be deleted.

post

Add a secondary EmailAddress to an Organisation.

put

Update a secondary EmailAddress.

delete

Delete an EmailAddress

post

Create a new CustomField value for this Organisation. Note: you can't add two values for one CustomField for the same Organisation. Use the appropriate *_value, based on CustomField.field_type.

put

Update a CustomFieldValue

get

List of Organisation's positions

CustomFieldCategory objects are used to group CustomField objects.

get

List of all CustomFieldCategory objects of Organisations.

CustomFields are used for account-specific data fields.

get

List of all CustomField objects of Organisations.

Segments are a subset of Organisations based on one or multiple rules.

get

Paginated list all Organisations in this Segment.

AddressType

AddressTypes are used to add multiple addresses to a Contact or Organisation.

get

List of all AddressTypes.

post

Create a new AddressType.

put

Update an AddressType.

delete

Delete an AddressType. The default AddressType or types currently used by Addresses cannot be deleted.

Groups

Groups are used to categorize Contacts and Organisations.

get

Recursive list of all Groups and their subgroups.

get

Paginated list of Contacts or Organisations that are currently in this group.

get

Paginated list of Contacts or Organisations that are in this group on a specific date.

Functions

Functions define roles that Contacts or Organisations have.

get

List of all Functions.

get

Paginated list of Contacts or Organisations that currently have this function.

get

Paginated list of Contacts or Organisations that have this function on a specific date.

Combinations

A Combination is the link between a Group and a Function and can be assigned to a Contact or Organisation.

get

List of all Combinations.

get

List of all Combinations that are linked to a certain Group.

get

List of all Combinations that are linked to a certain Function.

get

Paginated list of all Contacts or Organisations that currently have this Combination.

get

Paginated list of all Contacts or Organisations that have this Combination on a specific date.

Activities

Get, create and update Activities

get

Get all activities

The "internal" parameter can be given in the json file as "type".

post

Add a new internal activity

The "external" parameter can be given in the json file as "type".

post

Add a new external activity

The "annoucement" parameter can be given in the json file as "type".

post

Add a new annoucement

The "sale" parameter can be given in the json file as "type".

post

Add a new sale

get

Get all activities since the given start date

get

Get all activities ending before the given end date

get

Get all activities between the start and end date

put

Edit general info for an activity

delete

Delete an activity

The "internal" parameter must not be provided and will be determined by the type of activity.

get

Get details of an internal activity

The "external" parameter must not be provided and will be determined by the type of activity.

get

Get details of an external activity

The "sale" parameter must not be provided and will be determined by the type of activity.

get

Get details of a sale

The "announcement" parameter must not be provided and will be determined by the type of activity.

get

Get details of an announcement

The "session" parameter must not be provided and will be determined by the type of activity.

get

Get details of an session

get

Attendance list for an activity

get

Get all attachments for an activity

delete

Delete an attachment from an activity

post

Add a new attachment to an activity

get

Get products for an activity

post

Add a new product to an activity

put

Edit a product

delete

Delete a product from an activity

get

Product prices per grooup for a given activity

post

Add a product price to a given product

put

Update product price for a given product

delete

Delete product price (for a given product)

NewsPost

NewsPost in Peepl

get

List of all NewsPosts

post

Add a NewsPost

get

Get details of NewsPost

put

Edit a NewsPost

delete

Delete a NewsPost

get

Get all attachments of a newspost

post

Add a new attachment to a NewsPost

delete

Delete an attachment from a NewsPost

Folder

Folders in Peepl

get

List of all folders

post

Add a folder

get

Folder details

put

Edit folder details

delete

Delete a folder

Files

Files in Peepl

get

List of all files

get

Details of a file

delete

Delete a file

post

Add a file to folder

Picture Albums

Picture Albums in Peepl

get

List of all albums

post

Create an album

get

Details of an album

put

Edit album details

delete

Delete an album

Pictures

Pictures in Peepl

get

Get all pictures

get

Get details of a picture

delete

Delete a picture

post

Upload a picture