Activity resources. (an Activity is defined by the Type Field and usually represents a CRM/Merchandising Activity)

Activities

Method
Description

GET

get-activities

https://api.pepperi.com/v1.0/activities

Retrieves a list of activities including details about each activity and its nested objects.

GET

get-activity-by-id

https://api.pepperi.com/v1.0/activities/{id}

Retrieves a single activity by internal id.

GET

get-activity-by-externalid

https://api.pepperi.com/v1.0/activities/externalid/{id}

Retrieves a single activity by external id.

GET

get-activities-totals

https://api.pepperi.com/v1.0/totals/activities

Retrieves aggregated data for the activities resource.

GET

get-activities-metadata

https://api.pepperi.com/v1.0/metadata/activities

{Beta} Retrieves the activities metadata(schema).

GET

get-all-activities

https://api.pepperi.com/v1.0/all_activities

Retrieves a list of all activities including sales and other activities and details about each activity and its nested objects.

GET

get-all_activities-totals

https://api.pepperi.com/v1.0/totals/all_activities

Retrieves aggregated data for the all_activities resource.

POST

post-activities

https://api.pepperi.com/v1.0/activities

Upserts (updates/inserts) a single activity data. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-activities-bulk-json

https://api.pepperi.com/v1.0/bulk/activities/{subTypeId}/json

Starts a new async bulk upload job that upserts (updates/inserts) multiple activities data as a list of headers and lines.subTypeId should be taken from customization resources get-types-metadata. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-activities-bulk-csv-zip

https://api.pepperi.com/v1.0/bulk/activities/{subTypeId}/csv_zip

Starts a new async bulk upload job that upserts (updates/inserts) multiple activities data as a zip file that contains a single csv file. subTypeId should be taken from customization resources get-types-metadata. This async request returns a Job ID and URI to query the job's status. ExternalID is required in case of insert and either InternalID or ExternalID are required in case of update.

POST

post-activities-metadata-udf

https://api.pepperi.com/v1.0/metadata/activities

{Beta} Adds a new User Defined Field to the activities schema.

DELETE

delete-activity-by-id

https://api.pepperi.com/v1.0/activities/{id}

Deletes a single activity by internal id.

DELETE

delete-activity-by-externalid

https://api.pepperi.com/v1.0/activities/externalid/{id}

Deletes a single activity by external id.