{ "swagger": "2.0", "info": { "version": "v1", "title": "API Endpoints" }, "host": "public-api.donordock.com", "schemes": [ "https" ], "paths": { "/api/v1/ActivitySearch": { "get": { "tags": [ "Activities" ], "summary": "Search for activities", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Activities_ActivitySearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "contactIntegrationId", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memberId", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "phone", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "activityTypes", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Activities": { "get": { "tags": [ "Activities" ], "summary": "Get activities", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Activities_Activities", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" }, { "name": "excludeBulkEmailActivities", "in": "query", "description": "Set to true to exclude bulk email activites. Defaults to false.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierActivity]" } } } }, "post": { "tags": [ "Activities" ], "summary": "Create a new activity", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateActivity", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "za", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierActivity" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Activities/{activityId}": { "get": { "tags": [ "Activities" ], "summary": "Get an activity by ID", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Activities_GetActivityById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "activityId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierActivity" } } } }, "put": { "tags": [ "Activities" ], "operationId": "Activities_PutActivity", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "za", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierActivity" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Appeals": { "get": { "tags": [ "Appeals" ], "summary": "Get appeals", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Appeals_Appeals", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierAppeal]" } } } }, "post": { "tags": [ "Appeals" ], "summary": "Create a new appeal", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateAppeal", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "za", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierAppeal" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Appeals/{appealId}": { "get": { "tags": [ "Appeals" ], "summary": "Get appeal by ID", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Appeals_Appeal", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "appealId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierAppeal" } } } } }, "/api/v1/Badges": { "get": { "tags": [ "Badges" ], "summary": "Get contacts with badges", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Badges_Badges", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierDonorBadge]" } } } }, "post": { "tags": [ "Badges" ], "summary": "Add a badge to a contact", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "AddContactBadge", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "badge", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierDonorBadge" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "delete": { "tags": [ "Badges" ], "summary": "Remove a badge from a contact", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Badges_RemoveBadges", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "badge", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierDonorBadge" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Campaigns/CampaignSearch": { "get": { "tags": [ "Campaigns" ], "operationId": "Campaigns_CampaignSearchAsync", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Campaigns": { "get": { "tags": [ "Campaigns" ], "summary": "Get campaigns", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Campaigns_Campaigns", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierCampaign]" } } } }, "post": { "tags": [ "Campaigns" ], "summary": "Create a new campaign", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateCampaign", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "zc", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierCampaign" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Campaigns/{campaignId}": { "get": { "tags": [ "Campaigns" ], "summary": "Get campaign by Id", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Campaigns_GetCampaignById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "campaignId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierCampaign" } } } }, "put": { "tags": [ "Campaigns" ], "summary": "Update a Campaign", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Campaigns_PutCampaign", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "campaignId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "campaign", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ZapierCampaign" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get contacts", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Contacts_Contacts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierContact]" } } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a new contact", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateContact", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "d", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierContact" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Contacts/{contactId}": { "get": { "tags": [ "Contacts" ], "summary": "Get a contact by ID", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Contacts_GetContactById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contactId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierContact" } } } }, "put": { "tags": [ "Contacts" ], "summary": "Update an existing contact", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Contacts_PutContact", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "type": "string" }, { "name": "zapierContact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierContact" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Contacts/ContactSearch": { "get": { "tags": [ "Contacts" ], "summary": "Search for contacts", "operationId": "Contacts_ContactSearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memberId", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "phone", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "badgeFilters", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Emails/SendTemplateEmail": { "post": { "tags": [ "Emails" ], "summary": "Send an email to the specified contact using the specified template (Is deducted from marketing email credits)", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Emails_SendTemplateEmail", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "zf", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierTemplateEmail" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Events/Attendance": { "get": { "tags": [ "Events" ], "summary": "Get event attendance records", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Events_EventAttendance", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierEventAttendance]" } } } }, "post": { "tags": [ "Events" ], "summary": "Create a new event attendance record", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateEventAttendance", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "zf", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierEventAttendance" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Funds": { "get": { "tags": [ "Funds" ], "summary": "Get funds", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Funds_Funds", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierFund]" } } } }, "post": { "tags": [ "Funds" ], "summary": "Create a new fund", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateFund", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "zf", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierFund" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Funds/{fundId}": { "get": { "tags": [ "Funds" ], "operationId": "Funds_GetFundById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "fundId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierFund" } } } } }, "/api/v1/GiftBatches": { "get": { "tags": [ "GiftBatches" ], "summary": "Get closed gift batches", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "GiftBatches_GiftBatches", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter gift batches closed on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter gift batches closed on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by ClosedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GiftBatchPageResponse" } } } } }, "/api/v1/GiftBatches/{id}": { "get": { "tags": [ "GiftBatches" ], "summary": "Get a single gift batch by ID", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "GetGiftBatchById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ZapierGiftBatch" } } } } } }, "/api/v1/Gifts/GiftSearch": { "get": { "tags": [ "Gifts" ], "operationId": "Gifts_GiftSearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "paymentId", "in": "query", "required": false, "type": "string" }, { "name": "contactIntegrationId", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memberId", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "phone", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transactionType", "in": "query", "required": false, "type": "string" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Gifts": { "get": { "tags": [ "Gifts" ], "summary": "Get gifts", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "Gifts_Gifts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (\"CreatedOn\" or \"ModifiedOn\")", "required": false, "type": "string" }, { "name": "status", "in": "query", "description": "Gift Status(es) to filter by. Comma-delimited for multiple values. Enum: \"Received\" (default), \"Pledged\", \"Cancelled\", \"Pending\", \"Processing\"", "required": false, "type": "string" }, { "name": "transactionType", "in": "query", "description": "Transaction Type(s) to filter by. Comma-delimited for multiple values. Enum: \"Donation\", \"Membership\", \"EventTicket\", \"Grant\"", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierGift]" } } } }, "post": { "tags": [ "Gifts" ], "summary": "Create a new gift", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "CreateGift", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "g", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierGift" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/Gifts/{giftId}": { "get": { "tags": [ "Gifts" ], "summary": "Get gift by ID", "operationId": "Gifts_GiftById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "giftId", "in": "path", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierGift" } } } } }, "/api/v1/MarketingLists": { "get": { "tags": [ "MarketingLists" ], "summary": "Get contacts that have been added to marketing lists", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "MarketingLists_MarketingLists", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "description": "Max 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "description": "Filter records created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "Filter records created on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "description": "Filter records modified on or after this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "description": "Filter records modified on or before this date (UTC).", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "description": "Sort by CreatedOn date. \"DESC\" or \"ASC\"", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "description": "Field to sort by (CreatedOn or ModifiedOn)", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierMarketingListMember]" } } } }, "post": { "tags": [ "MarketingLists" ], "summary": "Add a contact to a marketing list", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "AddMarketingListContact", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "member", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierMarketingListMember" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Activities": { "get": { "tags": [ "McpActivities" ], "operationId": "McpActivities_ListActivities", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "required": false, "type": "string" }, { "name": "excludeBulkEmailActivities", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierActivity]" } } } }, "post": { "tags": [ "McpActivities" ], "operationId": "McpCreateActivity", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "za", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierActivity" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Activities/{activityId}": { "get": { "tags": [ "McpActivities" ], "operationId": "McpActivities_GetActivityById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierActivity" } } } }, "put": { "tags": [ "McpActivities" ], "operationId": "McpActivities_UpdateActivity", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "activityId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "za", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierActivity" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/ActivitySearch": { "get": { "tags": [ "McpActivities" ], "operationId": "McpActivities_ActivitySearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "contactIntegrationId", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memberId", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "phone", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "activityTypes", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Badges/Bulk": { "post": { "tags": [ "McpBadges" ], "operationId": "BulkAddContactBadges", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BulkBadgeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Contacts": { "get": { "tags": [ "McpContacts" ], "operationId": "McpContacts_Contacts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierContact]" } } } }, "post": { "tags": [ "McpContacts" ], "operationId": "McpCreateContact", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "d", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierContact" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Contacts/{contactId}": { "get": { "tags": [ "McpContacts" ], "operationId": "McpContacts_GetContactById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierContact" } } } }, "put": { "tags": [ "McpContacts" ], "operationId": "McpContacts_PutContact", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "type": "string" }, { "name": "zapierContact", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierContact" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Contacts/ContactSearch": { "get": { "tags": [ "McpContacts" ], "operationId": "McpContacts_ContactSearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memberId", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "phone", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "badgeFilters", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Fetch/Debug": { "post": { "tags": [ "McpFetch" ], "operationId": "McpFetch_FetchDebug", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Fetch": { "post": { "tags": [ "McpFetch" ], "operationId": "McpFetch_Fetch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Gifts/GiftSearch": { "get": { "tags": [ "McpGifts" ], "operationId": "McpGifts_GiftSearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "paymentId", "in": "query", "required": false, "type": "string" }, { "name": "contactIntegrationId", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memberId", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "phone", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transactionType", "in": "query", "required": false, "type": "string" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Gifts": { "get": { "tags": [ "McpGifts" ], "operationId": "McpGifts_Gifts", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "required": false, "type": "string" }, { "name": "status", "in": "query", "required": false, "type": "string" }, { "name": "transactionType", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierGift]" } } } }, "post": { "tags": [ "McpGifts" ], "operationId": "McpCreateGift", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "g", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierGift" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Gifts/{giftId}": { "get": { "tags": [ "McpGifts" ], "operationId": "McpGifts_GiftById", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "giftId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierGift" } } } } }, "/api/mcp/GiftTags/Bulk": { "post": { "tags": [ "McpGiftTags" ], "operationId": "McpGiftTags_BulkAddGiftTags", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BulkGiftTagsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/GiftTags": { "post": { "tags": [ "McpGiftTags" ], "operationId": "McpGiftTags_AddGiftTags", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AddGiftTagsRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/MarketingLists/Bulk": { "post": { "tags": [ "McpMarketingLists" ], "operationId": "BulkAddContactsToMarketingList", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BulkMarketingListRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/me/permissions": { "get": { "tags": [ "McpMe" ], "operationId": "McpMe_MyPermissions", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/MetaData/EntityMetaData": { "get": { "tags": [ "McpMetaData" ], "operationId": "McpMetaData_EntityMetaData", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "entityType", "in": "query", "required": true, "type": "string" }, { "name": "includeCustomFields", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/MetaData/EnumValues": { "get": { "tags": [ "McpMetaData" ], "operationId": "McpMetaData_EnumValues", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "entityTypes", "in": "query", "required": false, "type": "string" }, { "name": "includeCustomFields", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/Notes": { "get": { "tags": [ "McpNotes" ], "operationId": "McpNotes_ListNotes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "fromDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDateModified", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "sortDir", "in": "query", "required": false, "type": "string" }, { "name": "sortBy", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierNote]" } } } }, "post": { "tags": [ "McpNotes" ], "operationId": "CreateNote", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "zn", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierNote" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/mcp/NoteSearch": { "get": { "tags": [ "McpNotes" ], "operationId": "McpNotes_NoteSearch", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contactId", "in": "query", "required": false, "type": "string" }, { "name": "integrationId", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PageResponse[ZapierNote]" } } } } }, "/api/mcp/Notes/{noteId}": { "get": { "tags": [ "McpNotes" ], "operationId": "McpNotes_GetNote", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "noteId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ZapierNote" } } } }, "put": { "tags": [ "McpNotes" ], "operationId": "McpNotes_UpdateNote", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "noteId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "zn", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ZapierNote" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/MetaData/GetEmailTemplateList": { "get": { "tags": [ "MetaData" ], "summary": "Gets a list of email templates", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "MetaData_GetEmailTemplateList", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/MetaData/GetUserList": { "get": { "tags": [ "MetaData" ], "summary": "Gets a list of users", "description": "Basic Authentication over HTTPS:\r\n \r\n APIKey:APISecret encoded as Base64\r\n \r\n Send in Authorization header", "operationId": "MetaData_GetUserList", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/v1/MetaData/GetCustomFieldDefinitions": { "get": { "tags": [ "MetaData" ], "operationId": "MetaData_GetCustomFieldDefinitions", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "entityType", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } } }, "definitions": { "ZapierActivity": { "type": "object", "properties": { "Id": { "type": "string" }, "Subject": { "type": "string" }, "Body": { "type": "string" }, "Campaign": { "type": "string" }, "CampaignId": { "type": "string" }, "Fund": { "type": "string" }, "FundId": { "type": "string" }, "Appeal": { "type": "string" }, "AppealId": { "type": "string" }, "ScheduledDate": { "format": "date-time", "type": "string" }, "DueDate": { "format": "date-time", "type": "string" }, "ActivityDate": { "format": "date-time", "type": "string" }, "Type": { "type": "string" }, "ContactName": { "type": "string" }, "ContactId": { "type": "string" }, "ContactAccountNumber": { "type": "string" }, "ContactIntegrationId": { "type": "string" }, "ContactMemberId": { "type": "string" }, "Priority": { "type": "string" }, "Location": { "type": "string" }, "ContactEmail": { "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" }, "CompletedDate": { "format": "date-time", "type": "string" }, "CompletionNotes": { "type": "string" }, "CompletedBy": { "type": "string" }, "Status": { "type": "string" }, "AssignedToEmail": { "type": "string" }, "UserId": { "type": "string" }, "VolunteerHours": { "type": "string" }, "Badges": { "type": "string" }, "MarketingLists": { "type": "string" }, "AddToActionBoard": { "type": "boolean" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" }, "AskAmount": { "type": "string" }, "PlannedAskAmount": { "type": "string" }, "AskStage": { "type": "string" }, "AskProbability": { "type": "string" }, "CustomFields": { "type": "array", "items": { "$ref": "#/definitions/ZapierCustomField" } } } }, "ZapierCustomField": { "type": "object", "properties": { "FieldId": { "format": "int32", "type": "integer" }, "Label": { "type": "string", "readOnly": true }, "Description": { "type": "string", "readOnly": true }, "DataType": { "type": "string", "readOnly": true }, "Value": { "type": "object" }, "IsArchived": { "type": "boolean", "readOnly": true } } }, "PageResponse[ZapierActivity]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierActivity" } } } }, "ZapierAppeal": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" }, "AppealType": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" } } }, "PageResponse[ZapierAppeal]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierAppeal" } } } }, "PageResponse[ZapierDonorBadge]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierDonorBadge" } } } }, "ZapierDonorBadge": { "type": "object", "properties": { "Id": { "type": "string" }, "ContactName": { "type": "string" }, "ContactFirstName": { "type": "string" }, "ContactLastName": { "type": "string" }, "ContactId": { "type": "string" }, "ContactAccountNumber": { "type": "string" }, "ContactMemberId": { "type": "string" }, "ContactEmail": { "type": "string" }, "ContactIntegrationId": { "type": "string" }, "BadgeName": { "type": "string" }, "Source": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" } } }, "ZapierCampaign": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" } } }, "PageResponse[ZapierCampaign]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierCampaign" } } } }, "ZapierContact": { "type": "object", "properties": { "Id": { "type": "string" }, "AccountNumber": { "type": "string" }, "MemberId": { "type": "string" }, "Title": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" }, "FullName": { "type": "string" }, "DisplayName": { "type": "string" }, "Nickname": { "type": "string" }, "FormerName": { "type": "string" }, "OrganizationName": { "type": "string" }, "Addressee": { "type": "string" }, "Salutation": { "type": "string" }, "Suffix": { "type": "string" }, "Email": { "type": "string" }, "DOB": { "format": "date-time", "type": "string" }, "Address1": { "type": "string" }, "Address2": { "type": "string" }, "Address3": { "type": "string" }, "City": { "type": "string" }, "StateOrProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" }, "MainPhone": { "type": "string" }, "MobilePhone": { "type": "string" }, "Fax": { "type": "string" }, "Website": { "type": "string" }, "FacebookUsername": { "type": "string" }, "InstagramUsername": { "type": "string" }, "LinkedInUsername": { "type": "string" }, "TwitterUsername": { "type": "string" }, "DoNotSolicit": { "type": "boolean" }, "Deceased": { "type": "boolean" }, "Type": { "type": "string" }, "Description": { "type": "string" }, "Stage": { "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" }, "ExceptionNotes": { "type": "string" }, "Employer": { "type": "string" }, "JobTitle": { "type": "string" }, "Household": { "type": "string" }, "HouseholdRole": { "type": "string" }, "SpouseFirst": { "type": "string" }, "SpouseLast": { "type": "string" }, "Badges": { "type": "string" }, "MarketingLists": { "type": "string" }, "GiftsInDateRange": { "format": "double", "type": "number" }, "DonationGiftsInDateRange": { "format": "double", "type": "number" }, "EventTicketGiftsInDateRange": { "format": "double", "type": "number" }, "MembershipGiftsInDateRange": { "format": "double", "type": "number" }, "VolunteerHoursInDateRange": { "format": "double", "type": "number" }, "Owner": { "type": "string" }, "Affiliation": { "type": "string" }, "BadAddress": { "type": "boolean" }, "Unsubscribed": { "type": "boolean" }, "BadMobileNumber": { "type": "boolean" }, "SMSUnsubscribed": { "type": "boolean" }, "CustomFields": { "type": "array", "items": { "$ref": "#/definitions/ZapierCustomField" } }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" } } }, "PageResponse[ZapierContact]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierContact" } } } }, "ZapierTemplateEmail": { "type": "object", "properties": { "ContactId": { "type": "string" }, "ContactAccountNumber": { "type": "string" }, "ContactIntegrationId": { "type": "string" }, "ContactMemberId": { "type": "string" }, "ContactEmail": { "type": "string" }, "TemplateName": { "type": "string" }, "TemplateId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Subject": { "type": "string" }, "FromEmail": { "type": "string" } } }, "ZapierEventAttendance": { "type": "object", "properties": { "Id": { "type": "string" }, "Subject": { "type": "string" }, "Body": { "type": "string" }, "EventName": { "type": "string" }, "EventId": { "type": "string" }, "Appeal": { "type": "string" }, "ContactId": { "type": "string" }, "ContactAccountNumber": { "type": "string" }, "ContactMemberId": { "type": "string" }, "Date": { "format": "date-time", "type": "string" }, "AttendeeName": { "type": "string" }, "AttendeeEmail": { "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" }, "Badges": { "type": "string" }, "MarketingLists": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" } } }, "PageResponse[ZapierEventAttendance]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierEventAttendance" } } } }, "ZapierFund": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "AccountNumber": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" } } }, "PageResponse[ZapierFund]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierFund" } } } }, "GiftBatchPageResponse": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierGiftBatch" } } } }, "ZapierGiftBatch": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "ClosedDate": { "format": "date-time", "type": "string" }, "Gifts": { "type": "array", "items": { "$ref": "#/definitions/ZapierGift" } } } }, "ZapierGift": { "type": "object", "properties": { "Id": { "type": "string" }, "AccountNumber": { "type": "string" }, "ContactId": { "type": "string" }, "ContactMemberId": { "type": "string" }, "ReceivedAmount": { "format": "double", "type": "number" }, "NonDeductibleAmount": { "format": "double", "type": "number" }, "SoftCreditAmount": { "format": "double", "type": "number" }, "PledgedAmount": { "format": "double", "type": "number" }, "FeeAmount": { "format": "double", "type": "number" }, "NetAmount": { "format": "double", "type": "number" }, "FeesCovered": { "type": "boolean" }, "Date": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "Type": { "type": "string" }, "TransactionType": { "type": "string" }, "MembershipType": { "type": "string" }, "MembershipStart": { "format": "date-time", "type": "string" }, "MembershipEnd": { "format": "date-time", "type": "string" }, "PaymentId": { "type": "string" }, "CampaignName": { "type": "string" }, "AppealName": { "type": "string" }, "FundName": { "type": "string" }, "FundAccountNumber": { "type": "string" }, "TributeDescription": { "type": "string" }, "PaymentDescription": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" }, "DepositDate": { "format": "date-time", "type": "string" }, "ReferenceNumber": { "format": "int32", "type": "integer" }, "GiftTags": { "type": "string" }, "Title": { "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" }, "FullName": { "type": "string" }, "DisplayName": { "type": "string" }, "Nickname": { "type": "string" }, "FormerName": { "type": "string" }, "OrganizationName": { "type": "string" }, "Addressee": { "type": "string" }, "Salutation": { "type": "string" }, "Suffix": { "type": "string" }, "Email": { "type": "string" }, "DOB": { "format": "date-time", "type": "string" }, "Address1": { "type": "string" }, "Address2": { "type": "string" }, "Address3": { "type": "string" }, "City": { "type": "string" }, "StateOrProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" }, "MainPhone": { "type": "string" }, "MobilePhone": { "type": "string" }, "Fax": { "type": "string" }, "Website": { "type": "string" }, "DoNotSolicit": { "type": "boolean" }, "Deceased": { "type": "boolean" }, "DonorType": { "type": "string" }, "ContactIntegrationId": { "type": "string" }, "Description": { "type": "string" }, "TrackingCode": { "type": "string" }, "IntegrationId": { "type": "string" }, "Source": { "type": "string" }, "ExceptionNotes": { "type": "string" }, "Badges": { "type": "string" }, "MarketingLists": { "type": "string" }, "SendReceipt": { "type": "boolean" }, "Affiliation": { "type": "string" }, "OwnerName": { "type": "string" }, "ContactCustomFields": { "type": "array", "items": { "$ref": "#/definitions/ZapierCustomField" }, "readOnly": true }, "CustomFields": { "type": "array", "items": { "$ref": "#/definitions/ZapierCustomField" } } } }, "PageResponse[ZapierGift]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierGift" } } } }, "PageResponse[ZapierMarketingListMember]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierMarketingListMember" } } } }, "ZapierMarketingListMember": { "type": "object", "properties": { "Id": { "type": "string" }, "ContactName": { "type": "string" }, "ContactFirstName": { "type": "string" }, "ContactLastName": { "type": "string" }, "ContactId": { "type": "string" }, "ContactAccountNumber": { "type": "string" }, "ContactMemberId": { "type": "string" }, "ContactEmail": { "type": "string" }, "MarketingListName": { "type": "string" }, "Source": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" } } }, "BulkBadgeRequest": { "type": "object", "properties": { "BadgeName": { "type": "string" }, "ContactIds": { "type": "array", "items": { "type": "string" } }, "Source": { "type": "string" } } }, "BulkGiftTagsRequest": { "type": "object", "properties": { "TagNames": { "type": "string" }, "GiftIds": { "type": "array", "items": { "type": "string" } }, "Source": { "type": "string" } } }, "AddGiftTagsRequest": { "type": "object", "properties": { "GiftId": { "type": "string" }, "TagNames": { "type": "string" }, "Source": { "type": "string" } } }, "BulkMarketingListRequest": { "type": "object", "properties": { "MarketingListName": { "type": "string" }, "ContactIds": { "type": "array", "items": { "type": "string" } }, "Source": { "type": "string" } } }, "PageResponse[ZapierNote]": { "type": "object", "properties": { "TotalRecords": { "format": "int32", "type": "integer" }, "CurrentRecords": { "format": "int32", "type": "integer" }, "Data": { "type": "array", "items": { "$ref": "#/definitions/ZapierNote" } } } }, "ZapierNote": { "type": "object", "properties": { "Id": { "type": "string" }, "Subject": { "type": "string" }, "Body": { "type": "string" }, "Type": { "type": "string" }, "Status": { "type": "string" }, "ObjectType": { "type": "string" }, "ObjectId": { "type": "string" }, "ContactId": { "type": "string" }, "ContactName": { "type": "string" }, "ContactAccountNumber": { "type": "string" }, "ContactIntegrationId": { "type": "string" }, "ContactMemberId": { "type": "string" }, "ContactEmail": { "type": "string" }, "UserId": { "type": "string" }, "AssignedToEmail": { "type": "string" }, "IntegrationId": { "type": "string" }, "ImportJob": { "type": "string" }, "Source": { "type": "string" }, "CreatedBy": { "type": "string" }, "ModifiedBy": { "type": "string" }, "CreatedOn": { "format": "date-time", "type": "string" }, "ModifiedOn": { "format": "date-time", "type": "string" } } } } }