(Required) Environment
\n","key":"x-environment","value":"Start date
\n","type":"text/plain"},"key":"startDate","value":"End date
\n","type":"text/plain"},"key":"endDate","value":"(Required) Activity log Id
\n","type":"text/plain"},"type":"any","value":"The \"Activity\" folder centralizes access to system activity logs, empowering administrators with the tools needed to retrieve comprehensive activity records and conduct specific log searches. This capability is fundamental for auditing purposes, monitoring system usage, and identifying potential security incidents efficiently. Within this folder, users will find two primary endpoints:
\nRetrieve all activity logs: This endpoint offers a robust solution for fetching a list of activities, incorporating advanced querying capabilities such as pagination, sorting, and filtering. It facilitates a broad overview of activities across various dimensions, tailored to the user's requirements for period, roles, and other criteria.
\nFind an activity log: Retrieve the detail of an specific activity log.
\n(Required) Environment
\n","key":"x-environment","value":"This endpoint is dedicated to importing charity information from Donor Advised Funds (DAFs) into the system. It streamlines the process of integrating charity data directly from DAFs, facilitating seamless updates and expansions of the charity database with minimal manual intervention. This functionality is key to enhancing the database's comprehensiveness and accuracy by incorporating data from a variety of DAF sources.
\n","_postman_id":"5a3dc127-619d-4534-9f36-663b3753023c"},{"name":"Search","item":[{"name":"DB","item":[{"name":"Search for charities","id":"f57f1a2c-32c2-4e2d-8897-bff6779e3c43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"description":"(Required) Environment
\n","key":"x-environment","value":"Start date
\n","type":"text/plain"},"key":"startDate","value":"End date
\n","type":"text/plain"},"key":"endDate","value":"(Required)
\n","type":"text/plain"},"key":"name","value":"This endpoint provides a method for querying ChangeUp's internal database for charitable organizations.
\n","_postman_id":"d20d7039-23f5-4a50-b09d-96e318450c32"},{"name":"Activedonations","item":[{"name":"Search for active charity donations for a partner","id":"ccb1982e-4704-4bec-b81e-f65be459cad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"description":"(Required) Environment
\n","key":"x-environment","value":"Start date
\n","type":"text/plain"},"key":"startDate","value":"End date
\n","type":"text/plain"},"key":"endDate","value":"(Required)
\n","type":"text/plain"},"key":"name","value":"This API endpoint allows for the searching of charities with existing donations associated with a partner. It supports extensive filtering, sorting, and pagination options to tailor the search results according to specific needs.
\n","_postman_id":"c01aa364-47c7-4f8b-a800-be80ba35808e"},{"name":"Search for charities","id":"ff921550-5914-48cb-8675-b17856c622ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[{"description":"(Required) Environment
\n","key":"x-environment","value":"Start date
\n","type":"text/plain"},"key":"startDate","value":"End date
\n","type":"text/plain"},"key":"endDate","value":"(Required)
\n","type":"text/plain"},"key":"name","value":"This API endpoint is designed to facilitate the searching of charity-related data within the database. It incorporates a variety of parameters to fine-tune search results, including options for pagination, sorting, and filtering based on specific criteria.
\n","_postman_id":"14af9312-b2a2-4f03-9200-0cba98c31670"},{"name":"Upload","item":[{"name":"Upload artifact","id":"65646f9c-6055-4c86-9266-c3bff9422c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"description":"(Required) Environment
\n","key":"x-environment","value":"(Required)
\n","type":"text"},{"key":"location","value":"logo","description":"(Required) (This can only be one of logo,banner,gallery)
\n","type":"text"}]},"url":"https://api-staging.changeup.com/v1/charities/:id/upload","urlObject":{"path":["v1","charities",":id","upload"],"host":["https://api-staging.changeup.com"],"query":[],"variable":[{"id":"56d84d6f-258c-424d-a7b7-dd7a34c26393","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"This endpoint facilitates the uploading of documents and files related to a specific charity, identified by its unique ID. It enables users or administrators to update charity graphics (banners and logos).
\n","_postman_id":"c16c0ef7-5ce3-4eb7-9dee-b7edaac22f06"},{"name":"Create charity from scratch","id":"bf356733-b01f-40b1-8997-b4c606e7d3d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"POST","header":[{"description":"(Required) Environment
\n","key":"x-environment","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required) Environment
\n","key":"x-environment","value":"(Required) Charity ID
\n","type":"text/plain"},"type":"any","value":"This folder encompasses a range of functionalities for managing charities within the Donation Management System. It includes APIs for searching charities in the database, importing charity information from a Donor Advised Fund (DAF), uploading related artifacts, and creating charity profiles from scratch. This suite of APIs is essential for admins and partners to configure and manage the charities displayed on customer-facing widgets and to ensure that donations are directed appropriately.
\n","_postman_id":"c21c8db9-b85a-4a74-9b93-79107b43c480"},{"name":"Countries","item":[{"name":"Fetch all countries","id":"72e97c2e-8682-4236-a323-0ff4c517745d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api-staging.changeup.com/v1/countries","urlObject":{"path":["v1","countries"],"host":["https://api-staging.changeup.com"],"query":[],"variable":[]}},"response":[{"id":"a0d08c47-8c32-46be-b9f0-a867bb84d24d","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis endpoint provides a comprehensive list of countries, useful for applications requiring country data for selection menus, user profiles, or other internationalization features. It aims to offer a standardized source of country names and possibly related identifiers, such as country codes, to ensure consistency across the application's user interface and data handling practices.
\n","_postman_id":"4f96e2ed-6f74-4b2f-a027-2e7add4786b3"},{"name":"DAFs","item":[{"name":"Fetch all DAFs","id":"dee8a662-3b48-4215-99d4-eddd685980be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api-staging.changeup.com/v1/dafs","urlObject":{"path":["v1","dafs"],"host":["https://api-staging.changeup.com"],"query":[],"variable":[]}},"response":[{"id":"1e4313b6-3ee7-4fff-a2b0-1a98e1b6a00c","name":"Untitled Response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis endpoint is designed to list all Donor Advised Funds (DAFs) available within the system.
\n","_postman_id":"c13eec1a-8420-4691-ab65-55b0aaf9fee7"},{"name":"Donations","item":[{"name":"Create donation","id":"d9083679-b455-42fe-8422-6d8b02bb113e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"Secret Key
\n","type":"text"},{"key":"x-client-id","value":"Client Id
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"donations\": [\n {\n \"userDonationAmount\": 100, // 100 cents = $1\n \"partnerDonationAmount\": 100, // 100 cents = $1 // merchant maching\n //\"delayReportBy\": 0, // optional - delay donation by x amount of days\n \"causeId\": \"0810af66-23b3-4f26-9c09-83960cd6713b\", // Charity Id\n \"widget\": \"48e42f57-c703-47f6-842c-494724396794\", // widget Id created from DMS portal\n \"transactionId\": \"xOkIHPPNyCaSIv32Kvhn\", // use to tract your donation(s)\n \"transactionOrderDate\": \"2023-05-14T14:48:00.000Z\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://donations-staging.api.changeup.com/v1/donations","description":"Send a single or batch of donations.
\nThis API accepts an array of donation(s).
\nDonations generated through this endpoint will be posted to the configured DAF for the charity selected in your DMS portal.
\n\n\nNote: Donations are reported to the DAF immediately by default. To schedule a future report, set the delayReportBy parameter (e.g., a value of 5 will delay the report for 5 days). This allows you to cancel a donation before it is finalized. Please note that once a donation is posted after the delay period, it cannot be cancelled. The maximum allowable delay is 90 days.
\n