keap / keap-sdk
Keap REST Core Service
1.0.21
2025-07-24 19:40 UTC
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
Keap REST Core Service
For more information, please visit https://developer.keap.com/get-support/.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/infusionsoft/keap-sdk.git" } ], "require": { "infusionsoft/keap-sdk": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/core-v2-client/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Keap\Core\V2\Api\AffiliateApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $create_affiliate_request = new \Keap\Core\V2\Model\CreateAffiliateRequest(); // \Keap\Core\V2\Model\CreateAffiliateRequest | Affiliate request to insert try { $result = $apiInstance->addAffiliate($create_affiliate_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling AffiliateApi->addAffiliate: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.keap.com/crm/rest
Class | Method | HTTP request | Description |
---|---|---|---|
AffiliateApi | addAffiliate | POST /v2/affiliates | Create an Affiliate |
AffiliateApi | addAffiliateToProgram | POST /v2/affiliates/{id}:assignToProgram | Assign Affiliate to Commission program |
AffiliateApi | addCommissionProgram | POST /v2/affiliates/commissionPrograms | Create an Affiliate Commission Program |
AffiliateApi | assignProductCommissionProgram | POST /v2/affiliates/commissionPrograms/productCommissionPrograms/{commission_program_id} | Assign a Product Commission Program |
AffiliateApi | assignSubscriptionCommissionProgram | POST /v2/affiliates/commissionPrograms/subscriptionCommissionPrograms/{commission_program_id} | Assign a Subscription Commission Program |
AffiliateApi | createDefaultCommissionProgram | POST /v2/affiliates/commissionPrograms/defaultCommissionPrograms/{commission_program_id} | Create a Default Commission Program |
AffiliateApi | createRedirectLink | POST /v2/affiliates/redirects | Create an Affiliate Link |
AffiliateApi | deleteAffiliate | DELETE /v2/affiliates/{id} | Delete Affiliate |
AffiliateApi | deleteAffiliateCommissionProgram | DELETE /v2/affiliates/commissionPrograms/{commission_program_id} | Delete a Commission Program |
AffiliateApi | deleteRedirectLink | DELETE /v2/affiliates/redirects/{redirect_id} | Delete an Affiliate Link |
AffiliateApi | getAffiliate | GET /v2/affiliates/{id} | Retrieve an Affiliate |
AffiliateApi | getAffiliateCommissionTotal | GET /v2/affiliates/{affiliate_id}/commissionTotal | Retrieve Affiliate Commission Earned and View LedgerURl for portal |
AffiliateApi | getAffiliateCommissions | GET /v2/affiliates/{affiliate_id}:commissions | Retrieve Affiliate Commission and Clawbacks |
AffiliateApi | getCommissionProgram | GET /v2/affiliates/commissionPrograms/{commission_program_id} | Retrieve a Commission Program |
AffiliateApi | getRedirectLink | GET /v2/affiliates/redirects/{redirect_id} | Retrieve an Affiliate Link |
AffiliateApi | listAffiliateCommissionPrograms | GET /v2/affiliates/commissionPrograms | List Affiliate Commission Programs |
AffiliateApi | listAffiliateLinks | GET /v2/affiliates/redirects | List Affiliate Links |
AffiliateApi | listSummaries | GET /v2/affiliates/summaries | List Affiliate Summaries |
AffiliateApi | removeAffiliateFromProgram | POST /v2/affiliates/{id}:removeFromProgram | Remove an Affiliate from a Commission Program |
AffiliateApi | removeProductCommissionFromCommissions | POST /v2/affiliates/commissionPrograms/{commission_id}:removeProductCommission | Remove a Product from a Commission Program |
AffiliateApi | removeSubscriptionPlanCommissionFromCommissions | POST /v2/affiliates/commissionPrograms/{commission_id}:removeSubscriptionCommission | Remove a Subscription from a Commission Program |
AffiliateApi | updateAffiliate | PATCH /v2/affiliates/{id} | Update an Affiliate |
AffiliateApi | updateCommissionProgram | PATCH /v2/affiliates/commissionPrograms/{commission_program_id} | Update an Affiliate Commission Program |
AffiliateApi | updateDefaultCommissionProgram | PATCH /v2/affiliates/commissionPrograms/defaultCommissionPrograms/{commission_program_id} | Update a Default Commission Program |
AffiliateApi | updateProductCommissionProgram | PATCH /v2/affiliates/commissionPrograms/productCommissionPrograms/{commission_program_id} | Update a Product Commission Program |
AffiliateApi | updateRedirectLink | PATCH /v2/affiliates/redirects/{redirect_id} | Update an Affiliate Link |
AffiliateApi | updateSubscriptionCommissionProgram | PATCH /v2/affiliates/commissionPrograms/subscriptionCommissionPrograms/{commission_program_id} | Update a Subscription Commission Program |
AutomationApi | addContactsToAutomationSequence | POST /v2/automations/{automation_id}/sequences/{sequence_id}:addContacts | Add Contacts to an Automation Sequence |
AutomationApi | bulkAssignmentAutomationsCategories | POST /v2/automations/categories/batchAssign | Bulk update for Automations Categories |
AutomationApi | deleteAutomation | DELETE /v2/automations | Delete an Automation |
AutomationApi | getAutomation | GET /v2/automations/{automation_id} | Retrieve an Automation |
AutomationApi | listAllAutomationIds | GET /v2/automations/ids | List Automations Ids |
AutomationApi | listAutomations | GET /v2/automations | List Automations |
AutomationCategoryApi | createCategory | POST /v2/automationCategory | Create automation category |
AutomationCategoryApi | deleteCategories | DELETE /v2/automationCategory | Delete automation category |
AutomationCategoryApi | listCategories | GET /v2/automationCategory | List automation categories |
AutomationCategoryApi | patchCategory | PATCH /v2/automationCategory/{id} | Update automation category |
BusinessProfileApi | getBusinessProfile | GET /v2/businessProfile | Retrieve Business Profile |
BusinessProfileApi | updateBusinessProfile | PATCH /v2/businessProfile | Update Business Profile |
CampaignApi | addContactsToCampaignSequence | POST /v2/campaigns/{campaign_id}/sequences/{sequence_id}:addContacts | Add Contacts to Campaign Sequence |
CampaignApi | getCampaign | GET /v2/campaigns/{campaign_id} | Retrieve a Campaign |
CampaignApi | listCampaigns | GET /v2/campaigns | List Campaigns |
CampaignApi | removeContactsFromCampaignSequence | POST /v2/campaigns/{campaign_id}/sequences/{sequence_id}:removeContacts | Remove Contacts from Campaign Sequence |
CategoryDiscountsApi | createCategoryDiscount | POST /v2/discounts/productCategories | Create a Category Discount |
CategoryDiscountsApi | deleteCategoryDiscount | DELETE /v2/discounts/productCategories/{discount_id} | Delete a Category Discount |
CategoryDiscountsApi | getCategoryDiscount | GET /v2/discounts/productCategories/{discount_id} | Retrieve a Category Discount |
CategoryDiscountsApi | listCategoryDiscounts | GET /v2/discounts/productCategories | List Category Discounts |
CategoryDiscountsApi | updateCategoryDiscount | PATCH /v2/discounts/productCategories/{discount_id} | Update a Category Discount |
CompanyApi | createCompany | POST /v2/companies | Create a Company |
CompanyApi | deleteCompany | DELETE /v2/companies/{company_id} | Delete a Company |
CompanyApi | getCompany | GET /v2/companies/{company_id} | Retrieve a Company |
CompanyApi | listCompanies | GET /v2/companies | List Companies |
CompanyApi | updateCompany | PATCH /v2/companies/{company_id} | Update a Company |
ContactApi | createContact | POST /v2/contacts | Create a Contact |
ContactApi | createContactLinkType | POST /v2/contacts/links/types | Create a Contact Link type |
ContactApi | deleteContact | DELETE /v2/contacts/{contact_id} | Delete a Contact |
ContactApi | getContact | GET /v2/contacts/{contact_id} | Retrieve a Contact |
ContactApi | linkContacts | POST /v2/contacts:link | Link Contacts |
ContactApi | listContactLinkTypes | GET /v2/contacts/links/types | List Contact Link types |
ContactApi | listContactLinks | GET /v2/contacts/{contact_id}/links | List Linked Contacts |
ContactApi | listContacts | GET /v2/contacts | List Contacts |
ContactApi | retrieveContactModel | GET /v2/contacts/model | Retrieve Contact Model |
ContactApi | unlinkContacts | POST /v2/contacts:unlink | Delete Link between two Contacts |
ContactApi | updateContact | PATCH /v2/contacts/{contact_id} | Update a Contact |
EmailApi | createEmail | POST /v2/emails | Create an Email Record |
EmailApi | createEmails | POST /v2/emails:batchAdd | Create a set of Email Records |
EmailApi | deleteEmail | DELETE /v2/emails/{id} | Delete an Email Record |
EmailApi | deleteEmails | POST /v2/emails:batchRemove | Remove a set of Email Records |
EmailApi | getEmail | GET /v2/emails/{id} | Retrieve an Email |
EmailApi | getEmailTemplate | GET /v2/emails/templates/{email_template_id} | Retrieve an email template |
EmailApi | sendEmail | POST /v2/emails:send | Send an Email |
EmailApi | sendEmailTemplate | POST /v2/emails/templates:send | Send an email based on a template |
FilesApi | createFile | POST /v2/files | Create a file |
FilesApi | deleteFile | DELETE /v2/files/{file_id} | Delete a file |
FilesApi | getFile | GET /v2/files/{file_id} | Retrieve a file |
FilesApi | getFileData | GET /v2/files/{file_id}:data | Retrieve a file's data |
FilesApi | listFiles | GET /v2/files | List all files |
FilesApi | updateFile | POST /v2/files/{file_id} | Update a file |
FreeTrialDiscountsApi | createFreeTrialDiscount | POST /v2/discounts/freeTrials | Create a Subscription Free Trial Discount |
FreeTrialDiscountsApi | deleteFreeTrialDiscount | DELETE /v2/discounts/freeTrials/{discount_id} | Delete a Subscription Free Trial Discount |
FreeTrialDiscountsApi | getFreeTrialDiscount | GET /v2/discounts/freeTrials/{discount_id} | Retrieve a Subscription Free Trial Discount |
FreeTrialDiscountsApi | listFreeTrialDiscounts | GET /v2/discounts/freeTrials | List all Subscription Free Trial Discounts |
FreeTrialDiscountsApi | updateFreeTrialDiscount | PATCH /v2/discounts/freeTrials/{discount_id} | Update a Subscription Free Trial Discount |
LeadSourceCategoriesApi | createLeadSourceCategory | POST /v2/leadSourceCategories | Create a Lead Source Category |
LeadSourceCategoriesApi | deleteLeadSourceCategory | DELETE /v2/leadSourceCategories/{lead_source_category_id} | Delete a Lead Source Category |
LeadSourceCategoriesApi | getLeadSourceCategory | GET /v2/leadSourceCategories/{lead_source_category_id} | Retrieve a Lead Source Category |
LeadSourceCategoriesApi | listLeadSourceCategories | GET /v2/leadSourceCategories | List Lead Source Categories |
LeadSourceCategoriesApi | updateLeadSourceCategory | PATCH /v2/leadSourceCategories/{lead_source_category_id} | Update a Lead Source Category |
LeadSourceExpensesApi | createLeadSourceExpense | POST /v2/leadSources/{lead_source_id}/expenses | Create a Lead Source Expense |
LeadSourceExpensesApi | deleteLeadSourceExpense | DELETE /v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id} | Delete a lead source expense |
LeadSourceExpensesApi | getLeadSourceExpense | GET /v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id} | Retrieve a Lead Source Expense |
LeadSourceExpensesApi | listLeadSourceExpenses | GET /v2/leadSources/{lead_source_id}/expenses | List Lead Source Expenses |
LeadSourceExpensesApi | updateLeadSourceExpense | PATCH /v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id} | Update a Lead Source Expense |
LeadSourceRecurringExpensesApi | createLeadSourceRecurringExpense | POST /v2/leadSources/{lead_source_id}/recurringExpenses | Create a Lead Source Recurring Expense |
LeadSourceRecurringExpensesApi | deleteLeadSourceRecurringExpense | DELETE /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id} | Delete a Lead Source Recurring Expense |
LeadSourceRecurringExpensesApi | getLeadSourceRecurringExpense | GET /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id} | Retrieve a Lead Source Recurring Expense |
LeadSourceRecurringExpensesApi | listExpensesIncurredFromLeadSourceRecurringExpense | GET /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id}/expenses | Retrieves a list of expenses incurred from a recurring expense |
LeadSourceRecurringExpensesApi | listLeadSourceRecurringExpenses | GET /v2/leadSources/{lead_source_id}/recurringExpenses | Retrieves a list of lead source recurring expenses |
LeadSourceRecurringExpensesApi | updateLeadSourceRecurringExpense | PATCH /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id} | Update a Lead Source Recurring Expense |
LeadSourcesApi | createLeadSource | POST /v2/leadSources | Create a Lead Source |
LeadSourcesApi | deleteLeadSource | DELETE /v2/leadSources/{lead_source_id} | Delete a Lead Source |
LeadSourcesApi | getLeadSource | GET /v2/leadSources/{lead_source_id} | Retrieve a Lead Source |
LeadSourcesApi | listLeadSources | GET /v2/leadSources | List Lead Sources |
LeadSourcesApi | updateLeadSource | PATCH /v2/leadSources/{lead_source_id} | Update a Lead Source |
LocaleApi | getCountryByCode | GET /v2/locales/countries/{country_code} | Get Country |
LocaleApi | getProvinceByCode | GET /v2/locales/countries/{country_code}/provinces/{province_code} | Get Province |
LocaleApi | listCountries | GET /v2/locales/countries | List Countries |
LocaleApi | listProvincesForCountry | GET /v2/locales/countries/{country_code}/provinces | List a Country's Province |
MerchantsApi | listMerchants | GET /v2/merchants | List Merchant accounts |
NoteApi | createNote | POST /v2/contacts/{contact_id}/notes | Create a Note |
NoteApi | createNoteCustomField | POST /v2/notes/model/customFields | Create a Custom Field |
NoteApi | deleteNote | DELETE /v2/contacts/{contact_id}/notes/{note_id} | Delete a Note |
NoteApi | getNote | GET /v2/contacts/{contact_id}/notes/{note_id} | Retrieve a Note |
NoteApi | listNoteTemplates | GET /v2/notes/templates | Retrieve Note Templates |
NoteApi | listNotes | GET /v2/contacts/{contact_id}/notes | List Notes |
NoteApi | retrieveNoteModel | GET /v2/notes/model | Retrieve Note Model |
NoteApi | updateNote | PATCH /v2/contacts/{contact_id}/notes/{note_id} | Update a Note |
NoteApi | updateNotesCustomField | PATCH /v2/notes/model/customFields/{custom_field_id} | Update a Custom Field |
OpportunityApi | createOpportunity | POST /v2/opportunities | Create an Opportunity |
OpportunityApi | createOpportunityCustomFields | POST /v2/opportunities/model/customFields | Create an Opportunity Custom Field |
OpportunityApi | createOpportunityStage | POST /v2/opportunities/stages | Create an Opportunity Stage |
OpportunityApi | deleteOpportunity | DELETE /v2/opportunities/{opportunity_id} | Delete an Opportunity |
OpportunityApi | deleteOpportunityStage | DELETE /v2/opportunities/stages/{stage_id} | Delete an Opportunity Stage |
OpportunityApi | getOpportunity | GET /v2/opportunities/{opportunity_id} | Retrieve a Opportunity |
OpportunityApi | getOpportunityStage | GET /v2/opportunities/stages/{stage_id} | Retrieve an Opportunity Stage |
OpportunityApi | listOpportunities | GET /v2/opportunities | List Opportunities |
OpportunityApi | listOpportunityStages | GET /v2/opportunities/stages | List of Opportunity Stages |
OpportunityApi | updateOpportunity | PATCH /v2/opportunities/{opportunity_id} | Update an opportunity |
OpportunityApi | updateOpportunityCustomField | PATCH /v2/opportunities/model/customFields/{custom_field_id} | Update a Opportunity's Custom Field |
OpportunityApi | updateOpportunityStage | PATCH /v2/opportunities/stages/{stage_id} | Update an Opportunity Stage |
OrderTotalDiscountsApi | createOrderTotalDiscount | POST /v2/discounts/orderTotals | Create an Order Total Discount |
OrderTotalDiscountsApi | deleteOrderTotalDiscount | DELETE /v2/discounts/orderTotals/{discount_id} | Delete an Order Total Discount |
OrderTotalDiscountsApi | getOrderTotalDiscount | GET /v2/discounts/orderTotals/{discount_id} | Retrieve an Order Total Discount |
OrderTotalDiscountsApi | listOrderTotalDiscounts | GET /v2/discounts/orderTotals | List all Order Total Discounts |
OrderTotalDiscountsApi | updateOrderTotalDiscount | PATCH /v2/discounts/orderTotals/{discount_id} | Update an Order Total Discount |
OrdersApi | createOrderCustomField | POST /v2/orders/model/customFields | Create an Order Custom Field |
OrdersApi | deleteOrderCustomField | DELETE /v2/orders/model/customFields/{custom_field_id} | Delete an Order Custom Field |
OrdersApi | retrieveOrderCustomFieldModel | GET /v2/orders/model | Retrieve Order Custom Field Model |
OrdersApi | updateOrderCustomField | PATCH /v2/orders/model/customFields/{custom_field_id} | Update an Order Custom Field |
PaymentMethodConfigsApi | createPaymentMethodConfig | POST /v2/paymentMethodConfigs | Create Payment Method Configuration |
ProductCategoriesApi | assignProductsToCategory | POST /v2/productCategories/{category_id}:assignProducts | Assign Products to a Product Category |
ProductCategoriesApi | createImageFile | POST /v2/productCategories/{category_id}/images | Create the product category image file |
ProductCategoriesApi | createProductCategory | POST /v2/productCategories | Create a Product Category |
ProductCategoriesApi | deleteImageFile | DELETE /v2/productCategories/{category_id}/images | Delete the image from a product category |
ProductCategoriesApi | deleteProductCategory | DELETE /v2/productCategories/{category_id} | Delete a Product Category |
ProductCategoriesApi | getProductCategory | GET /v2/productCategories/{category_id} | Get a Product Category |
ProductCategoriesApi | listProductCategories | GET /v2/productCategories | List all Product Categories |
ProductCategoriesApi | updateProductCategory | PATCH /v2/productCategories/{category_id} | Update a Product Category |
ProductDiscountsApi | createProductDiscount | POST /v2/discounts/products | Create a Product Discount |
ProductDiscountsApi | deleteProductDiscount | DELETE /v2/discounts/products/{discount_id} | Delete a Product Discount |
ProductDiscountsApi | getProductDiscount | GET /v2/discounts/products/{discount_id} | Retrieve a Product Discount |
ProductDiscountsApi | listProductDiscounts | GET /v2/discounts/products | List all Product Discounts |
ProductDiscountsApi | updateProductDiscount | PATCH /v2/discounts/products/{discount_id} | Update a Product Discount |
ProductInterestBundlesApi | addProductInterest | POST /v2/productInterestBundles/{id}/interests | Create a Product Interest in an existing Bundle |
ProductInterestBundlesApi | createProductInterestBundle | POST /v2/productInterestBundles | Create a Product Interest Bundle |
ProductInterestBundlesApi | deleteProductInterestBundle | DELETE /v2/productInterestBundles/{id} | Delete a Product Interest Bundle |
ProductInterestBundlesApi | getProductInterestBundle | GET /v2/productInterestBundles/{id} | Get a Product Interest Bundle |
ProductInterestBundlesApi | listProductInterestBundles | GET /v2/productInterestBundles | List Product Interest Bundles |
ProductInterestBundlesApi | removeProductInterest | DELETE /v2/productInterestBundles/{id}/interests/{interest_id} | Delete a Product Interest from an existing Bundle |
ProductInterestBundlesApi | updateProductInterest | PATCH /v2/productInterestBundles/{id}/interests/{interest_id} | Update a Product Interest in an existing Bundle |
ProductInterestBundlesApi | updateProductInterestBundle | PATCH /v2/productInterestBundles/{id} | Update a Product Interest Bundle |
ProductsApi | adjustInventory | POST /v2/products/{product_id}:adjustInventory | Adjust Inventory of a Product |
ProductsApi | createProduct | POST /v2/products | Create a Product |
ProductsApi | createProductImage | POST /v2/products/{product_id}/images | Create the Product Image |
ProductsApi | deleteProduct | DELETE /v2/products/{product_id} | Delete a Product |
ProductsApi | deleteProductImage | DELETE /v2/products/{product_id}/images | Delete the Product Image |
ProductsApi | getProduct | GET /v2/products/{product_id} | Get a Product |
ProductsApi | listProducts | GET /v2/products | List Products |
ProductsApi | updateProduct | PATCH /v2/products/{product_id} | Update a Product |
ReportingApi | listReports | GET /v2/reporting/reports | List Reports |
ReportingApi | retrieveReport | GET /v2/reporting/reports/{report_id} | Retrieve Report |
ReportingApi | runReport | POST /v2/reporting/reports/{report_id}:run | Run a Report |
SalesApi | setMerchantGatewayAsDefault | POST /v2/sales/merchants/{id}:setDefault | Set default Merchant Account |
SettingsApi | getApplicationConfigurations | GET /v2/settings/applications:getConfiguration | Get Application Configuration |
SettingsApi | getContactOptionTypes | GET /v2/settings/contactOptionTypes | Get Contact Option types |
SettingsApi | isApplicationEnabled | GET /v2/settings/applications:isEnabled | Get Application Status |
ShippingApi | listShippingMethods | GET /v2/shipping | List Shipping methods |
ShippingDiscountsApi | createShippingDiscount | POST /v2/discounts/shipping | Create a Shipping Discount |
ShippingDiscountsApi | deleteShippingDiscount | DELETE /v2/discounts/shipping/{discount_id} | Delete a Shipping Discount |
ShippingDiscountsApi | getShippingDiscount | GET /v2/discounts/shipping/{discount_id} | Retrieve a Shipping Discount |
ShippingDiscountsApi | listShippingDiscounts | GET /v2/discounts/shipping | List all Shipping Discounts |
ShippingDiscountsApi | updateShippingDiscount | PATCH /v2/discounts/shipping/{discount_id} | Update a Shipping Discount |
SubscriptionPlansApi | createSubscriptionPlans | POST /v2/products/{product_id}/subscriptions | Create Subscription Plan |
SubscriptionPlansApi | deleteSubscriptionPlan | DELETE /v2/products/{product_id}/subscriptions/{subscription_plan_id} | Delete Subscription Plan |
SubscriptionPlansApi | fetchSubscriptionPlan | GET /v2/products/{product_id}/subscriptions/{subscription_plan_id} | Get Subscription Plan |
SubscriptionPlansApi | listSubscriptionPlans | GET /v2/products/{product_id}/subscriptions | List Subscription Plans |
SubscriptionPlansApi | updateSubscriptionPlan | PATCH /v2/products/{product_id}/subscriptions/{subscription_plan_id} | Update Subscription Plan |
SubscriptionsApi | createSubscription | POST /v2/subscriptions | Create Subscription |
SubscriptionsApi | createSubscriptionCustomField | POST /v2/subscriptions/model/customFields | Create a Subscription Custom Field |
SubscriptionsApi | deleteSubscriptionCustomField | DELETE /v2/subscriptions/model/customFields/{custom_field_id} | Delete a Subscription Custom Field |
SubscriptionsApi | retrieveSubscriptionCustomFieldModel | GET /v2/subscriptions/model | Retrieve Subscription Custom Field Model |
SubscriptionsApi | updateSubscriptionCustomField | PATCH /v2/subscriptions/model/customFields/{custom_field_id} | Update a Subscription Custom Field |
TagsApi | applyTags | POST /v2/tags/{tag_id}/contacts:applyTags | Apply Tag |
TagsApi | createTag | POST /v2/tags | Create Tag |
TagsApi | createTagCategory | POST /v2/tags/categories | Create Tag Category |
TagsApi | deleteTag | DELETE /v2/tags/{tag_id} | Delete Tag |
TagsApi | deleteTagCategory | DELETE /v2/tags/categories/{tag_category_id} | Delete Tag Category |
TagsApi | getCategory | GET /v2/tags/categories/{tag_category_id} | Retrieve a Tag Category |
TagsApi | getTag | GET /v2/tags/{tag_id} | Retrieve a Tag |
TagsApi | listCompaniesForTagId | GET /v2/tags/{tag_id}/companies | List Tagged Companies |
TagsApi | listContactsWithTagId | GET /v2/tags/{tag_id}/contacts | List Tagged Contacts |
TagsApi | listTagCategories | GET /v2/tags/categories | List Tag Categories |
TagsApi | listTags | GET /v2/tags | List Tags |
TagsApi | removeTags | POST /v2/tags/{tag_id}/contacts:removeTags | Remove Tags |
TagsApi | updateTag | PATCH /v2/tags/{tag_id} | Update a Tag |
TagsApi | updateTagCategory | PATCH /v2/tags/categories/{tag_category_id} | Update a Tag Category |
TaskApi | createTask | POST /v2/tasks | Create a Task |
TaskApi | createTaskCustomField | POST /v2/tasks/model/customFields | Create a Custom Field |
TaskApi | deleteTask | DELETE /v2/tasks/{task_id} | Delete a Task |
TaskApi | deleteTaskCustomField | DELETE /v2/tasks/model/customFields/{custom_field_id} | Delete a Custom Field |
TaskApi | getTask | GET /v2/tasks/{task_id} | Retrieve a Task |
TaskApi | listTasks | GET /v2/tasks | List Tasks |
TaskApi | retrieveTaskModel | GET /v2/tasks/model | Retrieve Task Model |
TaskApi | updateTask | PATCH /v2/tasks/{task_id} | Update a Task |
TaskApi | updateTaskCustomField | PATCH /v2/tasks/model/customFields/{custom_field_id} | Update a Task's Custom Field |
UsersApi | listPaginatedUsers | GET /v2/users | List Users |
Models
- AddContactsToSequenceRequest
- AddContactsToSequenceResponse
- AddProductInterestRequest
- AddToAutomationSequenceRequest
- AddToAutomationSequenceResponse
- Address
- AddressInformation
- AffiliateAddToProgramRequest
- AffiliateCommission
- AffiliateCommissionEarned
- AffiliateCommissionProgramResponse
- AffiliateLink
- AffiliateProgramV2
- AffiliateRemoveFromProgramRequest
- AffiliateSummaryRecord
- ApplicationCompany
- ApplicationConfigurationModuleAffiliate
- ApplicationConfigurationModuleAffiliateCommission
- ApplicationConfigurationModuleApplication
- ApplicationConfigurationModuleAppointment
- ApplicationConfigurationModuleContact
- ApplicationConfigurationModuleContactAddressLabels
- ApplicationConfigurationModuleEcommerce
- ApplicationConfigurationModuleEmail
- ApplicationConfigurationModuleForms
- ApplicationConfigurationModuleFulfillment
- ApplicationConfigurationModuleInvoice
- ApplicationConfigurationModuleNote
- ApplicationConfigurationModuleOpportunity
- ApplicationConfigurationModuleOpportunityStates
- ApplicationConfigurationModuleOpportunityStatesActive
- ApplicationConfigurationModuleOpportunityStatesLoss
- ApplicationConfigurationModuleOpportunityStatesWin
- ApplicationConfigurationModuleTask
- ApplicationConfigurationModuleTemplate
- ApplicationFeaturesEnabled
- ApplyRemoveTagRequest
- ApplyTagsResponse
- AssignAutomationCategoryRequest
- AssignProductsRequest
- Automation
- AutomationCategory
- AutomationLockStatus
- BasicCompany
- BasicContact
- BasicUser
- BusinessProfileAddressRequest
- BusinessProfileAddressResponse
- Campaign
- CancelSubscriptionRequest
- CardInfo
- CategoryDiscount
- CategoryReference
- CheckListItemDetails
- ChecklistItem
- Company
- Contact
- ContactLink
- ContactLinkType
- ContactUtmResponse
- Country
- CountryCodes
- CreateAffiliateRequest
- CreateAutomationCategoryRequest
- CreateCategoryDiscountRequest
- CreateCommissionProgramRequest
- CreateCompanyRequest
- CreateContactLinkTypeRequest
- CreateContactUtmPropertiesRequest
- CreateCustomFieldOptionRequest
- CreateCustomFieldRequest
- CreateCustomFieldResponse
- CreateDefaultCommissionProgramRequest
- CreateEmailSentRequest
- CreateEmailsSentRequest
- CreateFreeTrialDiscountRequest
- CreateFunnelIntegrationRequest
- CreateFunnelIntegrationTriggerEvents
- CreateLeadSourceExpenseRequest
- CreateLeadSourceRecurringExpenseRequest
- CreateLeadSourceRequest
- CreateNoteRequest
- CreateOpportunityRequest
- CreateOpportunityStageChecklistItem
- CreateOpportunityStageRequest
- CreateOrUpdateAffiliateLinkRequest
- CreateOrderTotalDiscountRequest
- CreatePaymentMethodConfigRequest
- CreatePaymentRequest
- CreateProductCategoryRequest
- CreateProductCommissionProgramRequest
- CreateProductDiscountRequest
- CreateProductInterestBundleRequest
- CreateProductRequest
- CreateReferralRequest
- CreateRestOrderItemRequest
- CreateShippingDiscountRequest
- CreateSubscriptionCommissionProgramRequest
- CreateSubscriptionPlanRequest
- CreateSubscriptionRequest
- CreateTaskRequest
- CreateUpdateContactRequest
- CreateUpdateLeadSourceCategoryRequest
- CreateUpdateTagCategoryRequest
- CreateUpdateTagRequest
- CreateUpdateTaskRequest
- CreateUserRequestV2
- CurrencyValue
- CustomField
- CustomFieldMetaData
- CustomFieldOption
- CustomFieldValue
- DefaultCommission
- DeleteEmailsRequest
- DeleteEmailsResponse
- DeleteFunnelIntegrationRequest
- DeleteProgramCommissionRequest
- DeleteSubscriptionPlanCommissionRequest
- Discount
- DiscountCriteria
- EmailAddress
- EmailAddressRequest
- EmailAddressStatus
- EmailSendRequest
- EmailSendRequestAttachment
- EmailSendTemplateRequest
- EmailSent
- EmailSentCreateError
- EmailSentWithContent
- EmailTemplate
- EmailsSentList
- Error
- ErrorDetails
- FaxNumber
- File
- FileMetadata
- FileOperationRequest
- FreeTrialDiscount
- FunnelIntegrationAction
- FunnelIntegrationHttpRequest
- FunnelIntegrationSchemaField
- FunnelIntegrationTriggerEventDTO
- FunnelIntegrationTriggerResultDTO
- GetApplicationEnabledStatusResponse
- GetBusinessProfileResponse
- GetContactOptionTypesResponse
- GetNoteResponse
- GetSettingsResponse
- GetTagCategoryResponse
- GetUserInfoResponse
- Goal
- HistoricalCounts
- InvoiceFile
- InvoiceOrderPayment
- Item
- LandingPage
- LeadScore
- LeadSource
- LeadSourceCategory
- LeadSourceExpense
- LeadSourceRecurringExpense
- LeadSourceRecurringExpenseUpdateRequest
- Link
- LinkContactsRequest
- ListAffiliateCommissionProgramsResponse
- ListAffiliateCommissionsResponse
- ListAffiliateLinksResponse
- ListAffiliateSummariesResponse
- ListAffiliatesResponse
- ListAutomationCategoryResponse
- ListAutomationIdsResponse
- ListAutomationResponse
- ListBasicContactResponse
- ListCampaignsResponse
- ListCategoryDiscountsResponse
- ListCompaniesResponse
- ListContactLinkTypesResponse
- ListContactLinksResponse
- ListContactsResponse
- ListCountriesResponse
- ListEmailsSentResponse
- ListFilesResponse
- ListFreeTrialDiscountsResponse
- ListLandingPagesResponse
- ListLeadSourceCategoriesResponse
- ListLeadSourceExpensesResponse
- ListLeadSourceRecurringExpensesResponse
- ListLeadSourcesResponse
- ListMerchantAccountResponse
- ListMerchantsResponse
- ListNoteTemplateResponse
- ListNotesResponse
- ListOpportunitiesResponse
- ListOpportunityStagesResponse
- ListOrderPaymentsResponse
- ListOrderTotalDiscountsResponse
- ListOrders
- ListPaymentMethodsResponse
- ListProductCategoriesResponse
- ListProductDiscountsResponse
- ListProductInterestBundleResponse
- ListProductsResponse
- ListProvincesResponse
- ListReportsResponse
- ListRestShippingMethodsResponse
- ListShippingDiscountsResponse
- ListSubscriptionPlansResponse
- ListSubscriptionsResponse
- ListTagCategoriesResponse
- ListTaggedCompaniesResponse
- ListTaggedContactsResponse
- ListTagsResponse
- ListTasksResponse
- ListUsersPaginatedResponse
- Note
- NoteTemplate
- ObjectModel
- OpportunityContact
- OpportunityStage
- OrderItemProduct
- OrderItemTax
- OrderTotalDiscount
- Origin
- OriginRequest
- PatchAutomationCategoryRequest
- PaymentMethod
- PaymentMethodConfig
- PaymentPlan
- PaymentResult
- PhoneNumber
- ProductCategory
- ProductCommission
- ProductCommissionProgram
- ProductDiscount
- ProductFixedOption
- ProductInterest
- ProductInterestBundle
- ProductInventory
- ProductOptions
- ProductVariableSetting
- Province
- Referral
- RemoveContactsFromSequenceRequest
- RemoveContactsFromSequenceResponse
- Report
- ReportEntryRecord
- ReportEntryValue
- ReportExecutionResult
- Resource
- RestAffiliate
- RestApplyCommissionRequest
- RestCreateOrderRequest
- RestEmailAddress
- RestOpportunityStage
- RestProductOption
- RestProductOptionValue
- RestSubscriptionPlan
- RestV2Opportunity
- RestV2Order
- RestV2OrderItem
- RestV2Product
- RestV2Subscription
- RestV2User
- Sequence
- SequencePath
- SetDefaultCommissionProgramResponse
- ShippingDiscount
- ShippingInformation
- ShippingMethod
- SocialAccount
- StackTraceElement
- StageDetails
- Subscription
- SubscriptionCommission
- SubscriptionCommissionProgram
- SubscriptionPlan
- Tag
- TaggedCompany
- Task
- Throwable
- URI
- URL
- UpdateAffiliateRequest
- UpdateBusinessProfileRequest
- UpdateCategoryDiscountRequest
- UpdateCommissionProgramRequest
- UpdateCompanyRequest
- UpdateCustomFieldMetaDataRequest
- UpdateDefaultCommissionProgramRequest
- UpdateEmailAddress
- UpdateFreeTrialDiscountRequest
- UpdateLeadSourceExpenseRequest
- UpdateNoteRequest
- UpdateNoteResponse
- UpdateOpportunityRequestV2
- UpdateOpportunityStageChecklistItem
- UpdateOpportunityStageRequest
- UpdateOrderItemRequest
- UpdateOrderRequest
- UpdateOrderTotalDiscountRequest
- UpdateProductCategoryRequest
- UpdateProductCommissionProgramRequest
- UpdateProductDiscountRequest
- UpdateProductInterestBundleRequest
- UpdateProductInterestRequest
- UpdateProductInventoryRequest
- UpdateProductRequest
- UpdateShippingDiscountRequest
- UpdateSubscriptionCommissionProgramRequest
- UpdateSubscriptionPlanRequest
- UpdateSubscriptionRequest
- UpdateTagCategoryResponse
- UpdateTagResponse
- UpdateTaskResponse
- UpdateUserRequest
- UpdatedPaymentPlan
- User
Authorization
Authentication schemes defined for the API:
oauth2
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
https://accounts.infusionsoft.com/app/oauth/authorize
- Scopes: N/A
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
2.70.0.834462-hf-202507221415
- Package version:
1.0.21
- Generator version:
7.13.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen