Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account Addresses

accountAddressesSchema

accountAddresses.accountAddressesSchema Account Addresses schema (GET /accountAddresses/schema) Risk: read
Input
Output

createAccountAddress

accountAddresses.createAccountAddress Create Account Address (POST /accountAddresses) Risk: write
Input
Output

deleteAccountAddress

accountAddresses.deleteAccountAddress Delete Account Address (DELETE /accountAddresses/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getAccountAddress

accountAddresses.getAccountAddress Get Account Address (GET /accountAddresses/{ID}) Risk: read
Input
Output

listAccountAddresses

accountAddresses.listAccountAddresses List Account Addresses (GET /accountAddresses) Risk: read
Input
Output: object[]

updateAccountAddress

accountAddresses.updateAccountAddress Update Account Address (PUT /accountAddresses/{ID}) Risk: write
Input
Output

Accounts Entity

accountsSchema

accountsEntity.accountsSchema Accounts schema (GET /accounts/schema) Risk: read
Input
Output

createAccount

accountsEntity.createAccount Create Account (POST /accounts) Risk: write
Input
Output

deleteAccount

accountsEntity.deleteAccount Delete Account (DELETE /accounts/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getAccount

accountsEntity.getAccount Get Account (GET /accounts/{ID}) Risk: read
Input
Output

listAccounts

accountsEntity.listAccounts List Accounts (GET /accounts) Risk: read
Input
Output: object[]

updateAccount

accountsEntity.updateAccount Update Account (PUT /accounts/{ID}) Risk: write
Input
Output

Accounts Segments

accountSegmentsSchema

accountsSegments.accountSegmentsSchema Account Segments schema (GET /accountSegments/schema) Risk: read
Input
Output

createAccountSegment

accountsSegments.createAccountSegment Create Account Segment (POST /accountSegments) Risk: write
Input
Output

deleteAccountSegment

accountsSegments.deleteAccountSegment Delete Account Segment (DELETE /accountSegments/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getAccountSegment

accountsSegments.getAccountSegment Get Account Segment (GET /accountSegments/{ID}) Risk: read
Input
Output

listAccountSegments

accountsSegments.listAccountSegments List Account Segments (GET /accountSegments) Risk: read
Input
Output: object[]

updateAccountSegment

accountsSegments.updateAccountSegment Update Account Segment (PUT /accountSegments/{ID}) Risk: write
Input
Output

Accounts Statuses

accountStatusesSchema

accountsStatuses.accountStatusesSchema Account Statuses schema (GET /accountStatuses/schema) Risk: read
Input
Output

createAccountStatus

accountsStatuses.createAccountStatus Create Account Status (POST /accountStatuses) Risk: write
Input
Output

deleteAccountStatus

accountsStatuses.deleteAccountStatus Delete Account Status (DELETE /accountStatuses/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getAccountStatus

accountsStatuses.getAccountStatus Get Account Status (GET /accountStatuses/{ID}) Risk: read
Input
Output

listAccountStatuses

accountsStatuses.listAccountStatuses List Account Statuses (GET /accountStatuses) Risk: read
Input
Output: object[]

updateAccountStatus

accountsStatuses.updateAccountStatus Update Account Status (PUT /accountStatuses/{ID}) Risk: write
Input
Output

Accounts Types

accountTypesSchema

accountsTypes.accountTypesSchema Account Types schema (GET /accountTypes/schema) Risk: read
Input
Output

createAccountType

accountsTypes.createAccountType Create Account Type (POST /accountTypes) Risk: write
Input
Output

deleteAccountType

accountsTypes.deleteAccountType Delete Account Type (DELETE /list/accountTypes/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getAccountType

accountsTypes.getAccountType Get Account Type (GET /accountTypes/{ID}) Risk: read
Input
Output

listAccountTypes

accountsTypes.listAccountTypes List Account Types (GET /accountTypes) Risk: read
Input
Output: object[]

updateAccountType

accountsTypes.updateAccountType Update Account Type (PUT /list/accountTypes/{ID}) Risk: write
Input
Output

Activities Entity

activitiesSchema

activitiesEntity.activitiesSchema Activities schema (GET /activities/schema) Risk: read
Input
Output

createActivity

activitiesEntity.createActivity Create Activity (POST /activities) Risk: write
Input
Output

deleteActivity

activitiesEntity.deleteActivity Delete Activity (DELETE /activities/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getActivity

activitiesEntity.getActivity Get Activity (GET /activities/{ID}) Risk: read
Input
Output

listActivities

activitiesEntity.listActivities List Activities (GET /activities) Risk: read
Input
Output: object[]

updateActivity

activitiesEntity.updateActivity Update Activity (PUT /activities/{ID}) Risk: write
Input
Output

Activities Points

listActivityPoints

activitiesPoints.listActivityPoints List Activity Points (GET /activity/points) Risk: read
Input
Output

updateActivityPoints

activitiesPoints.updateActivityPoints Update Activity Points (PUT /activity/points) Risk: write
Input
Output

Activities Types

activityTypesSchema

activitiesTypes.activityTypesSchema Activity Types schema (GET /activityTypes/schema) Risk: read
Input
Output

createActivityType

activitiesTypes.createActivityType Create Activity Type (POST /activityTypes) Risk: write
Input
Output

deleteActivityType

activitiesTypes.deleteActivityType Delete Activity Type (DELETE /activityTypes/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getActivityType

activitiesTypes.getActivityType Get Activity Type (GET /activityTypes/{ID}) Risk: read
Input
Output

listActivityTypes

activitiesTypes.listActivityTypes List Activity Types (GET /activityTypes) Risk: read
Input
Output: object[]

updateActivityType

activitiesTypes.updateActivityType Update Activity Type (PUT /activityTypes/{ID}) Risk: write
Input
Output

Branches

branchesSchema

branches.branchesSchema Branches schema (GET /branches/schema) Risk: read
Input
Output

deleteBranch

branches.deleteBranch Delete Branch (DELETE /branches/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getBranch

branches.getBranch Get Branch (GET /branches/{ID}) Risk: read
Input
Output

listBranches

branches.listBranches List Branches (GET /branches) Risk: read
Input
Output: object[]

Bulks

bulkCreateResources

bulks.bulkCreateResources Bulk Create Resources (POST /VALUE/bulk) Risk: destructive
Input Creates up to 200 records of the named resource in one call. For users or calendar events the same charges and invitation emails apply as for the single-record calls.
Output: object[]

bulkDeleteResources

bulks.bulkDeleteResources Bulk Delete Resources (DELETE /VALUE/bulk) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output: object[]

bulkUpdateResources

bulks.bulkUpdateResources Bulk Update Resources (PUT /VALUE/bulk) Risk: destructive
Input Updates up to 200 records of the named resource in one call. For users or calendar events the same charges and invitation emails apply as for the single-record calls.
Output: object[]

Calls

createCallByUserId

calls.createCallByUserId Create Call by User ID (POST /calls) Risk: write
Input
Output: object[]

createCallByUserPhoneNumber

calls.createCallByUserPhoneNumber Create Call by User Phone Number (POST /calls/identify) Risk: write
Input
Output

deleteCall

calls.deleteCall Delete Call (DELETE /calls/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output: JsonValue

getCall

calls.getCall Get Call (GET /calls/{ID}) Risk: read
Input
Output

getResourcesByPhoneNumber

calls.getResourcesByPhoneNumber Get Resources by Phone Number (GET /calls/phone/VALUE) Risk: read
Input
Output

listCalls

calls.listCalls List Calls (GET /calls) Risk: read
Input
Output: object[]

updateCall

calls.updateCall Update Call (PUT /calls/{ID}) Risk: write
Input
Output

Campaigns Accounts

createCampaignAccount

campaignsAccounts.createCampaignAccount Create Campaign Account (POST /campaigns/{ID}/entities/VALUE) Risk: write
Input
Output

deleteCampaignAccount

campaignsAccounts.deleteCampaignAccount Delete Campaign Account (DELETE /campaigns/{ID}/entities/VALUE) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getCampaignAccount

campaignsAccounts.getCampaignAccount Get Campaign Account (GET /campaigns/{ID}/entities/VALUE) Risk: read
Input
Output

listCampaignAccounts

campaignsAccounts.listCampaignAccounts List Campaign Accounts (GET /campaigns/{ID}/entities) Risk: read
Input
Output: JsonValue

updateCampaignAccount

campaignsAccounts.updateCampaignAccount Update Campaign Account (PUT /campaigns/{ID}/entities/VALUE) Risk: write
Input
Output

Campaigns Entity

createCampaign

campaignsEntity.createCampaign Create Campaign (POST /campaigns) Risk: write
Input
Output

deleteCampaign

campaignsEntity.deleteCampaign Delete Campaign (DELETE /campaigns/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getCampaign

campaignsEntity.getCampaign Get Campaign (GET /campaigns/{ID}) Risk: read
Input
Output

listCampaigns

campaignsEntity.listCampaigns List Campaigns (GET /campaigns) Risk: read
Input
Output: object[]

updateCampaign

campaignsEntity.updateCampaign Update Campaign (PUT /campaigns/{ID}) Risk: write
Input
Output

Campaigns Question Answers

createQuestionAnswer

campaignsQuestionAnswers.createQuestionAnswer Create Question Answer (POST /campaignQuestions/VALUE/answers) Risk: write
Input
Output

deleteQuestionAnswer

campaignsQuestionAnswers.deleteQuestionAnswer Delete Question Answer (DELETE /campaignQuestions/VALUE/answers/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getQuestionAnswer

campaignsQuestionAnswers.getQuestionAnswer Get Question Answer (GET /campaignQuestions/VALUE/answers/{ID}) Risk: read
Input
Output

listQuestionAnswers

campaignsQuestionAnswers.listQuestionAnswers List Question Answers (GET /campaignQuestions/VALUE/answers) Risk: read
Input
Output: object[]

updateQuestionAnswer

campaignsQuestionAnswers.updateQuestionAnswer Update Question Answer (PUT /campaignQuestions/VALUE/answers/{ID}) Risk: write
Input
Output

Campaigns Questions

createCampaignQuestion

campaignsQuestions.createCampaignQuestion Create Campaign Question (POST /campaignQuestions) Risk: write
Input
Output: object[]

deleteCampaignQuestion

campaignsQuestions.deleteCampaignQuestion Delete Campaign Question (DELETE /campaignQuestions/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getCampaignQuestion

campaignsQuestions.getCampaignQuestion Get Campaign Question (GET /campaignQuestions/{ID}) Risk: read
Input
Output

listCampaignQuestions

campaignsQuestions.listCampaignQuestions List Campaign Questions (GET /campaignQuestions) Risk: read
Input
Output: object[]

updateCampaignQuestion

campaignsQuestions.updateCampaignQuestion Update Campaign Question (PUT /campaignQuestions/{ID}) Risk: write
Input
Output

Campaigns Question Values

createQuestionValue

campaignsQuestionValues.createQuestionValue Create Question Value (POST /campaignQuestions/{ID}/values) Risk: write
Input
Output

deleteQuestionValue

campaignsQuestionValues.deleteQuestionValue Delete Question Value (DELETE /campaignQuestions/VALUE/values/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getQuestionValue

campaignsQuestionValues.getQuestionValue Get Question Value (GET /campaignQuestions/VALUE/values/{ID}) Risk: read
Input
Output

listQuestionValues

campaignsQuestionValues.listQuestionValues List Question Values (GET /campaignQuestions/VALUE/values) Risk: read
Input
Output: object[]

updateQuestionValue

campaignsQuestionValues.updateQuestionValue Update Question Value (PUT /campaignQuestions/VALUE/values/{ID}) Risk: write
Input
Output

Campaigns Statuses

listCampaignStatuses

campaignsStatuses.listCampaignStatuses List Campaign Statuses (GET /campaignStatuses) Risk: read
Input
Output: object[]

Contacts Entity

contactsSchema

contactsEntity.contactsSchema Contacts schema (GET /contacts/schema) Risk: read
Input
Output

createContact

contactsEntity.createContact Create Contact (POST /contacts) Risk: write
Input
Output

deleteContact

contactsEntity.deleteContact Delete Contact (DELETE /contacts/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getContact

contactsEntity.getContact Get Contact (GET /contacts/{ID}) Risk: read
Input
Output

listContacts

contactsEntity.listContacts List Contacts (GET /contacts) Risk: read
Input
Output: object[]

updateContact

contactsEntity.updateContact Update Contact (PUT /contacts/{ID}) Risk: write
Input
Output

Contacts Types

contactTypesSchema

contactsTypes.contactTypesSchema Contact Types schema (GET /contactTypes/schema) Risk: read
Input
Output

createContactType

contactsTypes.createContactType Create Contact Type (POST /contactTypes) Risk: write
Input
Output

deleteContactType

contactsTypes.deleteContactType Delete Contact Type (DELETE /contactTypes/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getContactType

contactsTypes.getContactType Get Contact Type (GET /contactTypes/{ID}) Risk: read
Input
Output

listContactTypes

contactsTypes.listContactTypes List Contact Types (GET /contactTypes) Risk: read
Input
Output: object[]

updateContactType

contactsTypes.updateContactType Update Contact Type (PUT /contactTypes/{ID}) Risk: write
Input
Output

Countries

countriesSchema

countries.countriesSchema Countries schema (GET /countries/schema) Risk: read
Input
Output

listCountries

countries.listCountries List Countries (GET /countries) Risk: read
Input
Output: object[]

Currencies

currenciesSchema

currencies.currenciesSchema Currencies schema (GET /currencies/schema) Risk: read
Input
Output

listCurrencies

currencies.listCurrencies List Currencies (GET /currencies) Risk: read
Input
Output: object[]

Documents Entity

listDocuments

documentsEntity.listDocuments List Documents (GET /documents) Risk: read
Input
Output: object[]

listDocumentsOfAResource

documentsEntity.listDocumentsOfAResource List Documents of a Resource (GET /VALUE/VALUE/documents) Risk: read
Input
Output: object[]

Documents Folders

createFolder

documentsFolders.createFolder Create Folder (POST /documents/folders) Risk: write
Input
Output

createFolderForAResource

documentsFolders.createFolderForAResource Create Folder for a Resource (POST /VALUE/VALUE/documents/folders) Risk: write
Input
Output

listFolders

documentsFolders.listFolders List Folders (GET /documents/folders) Risk: read
Input
Output: object[]

listFoldersOfAResource

documentsFolders.listFoldersOfAResource List Folders of a Resource (GET /VALUE/VALUE/documents/folders) Risk: read
Input
Output: object[]

Emails

createEmail

emails.createEmail Create Email (POST /emails) Risk: write
Input
Output: object[]

emailsSchema

emails.emailsSchema Emails schema (GET /emails/schema) Risk: read
Input
Output

getEmail

emails.getEmail Get Email (GET /emails/{ID}) Risk: read
Input
Output: JsonValue

listEmails

emails.listEmails List Emails (GET /emails) Risk: read
Input
Output: object[]

Entity Contacts

entityContactsSchema

entityContacts.entityContactsSchema Entity Contacts schema (GET /contactsEntities/schema) Risk: read
Input
Output: JsonValue

listEntityContacts

entityContacts.listEntityContacts List Entity Contacts (GET /contactsEntities) Risk: read
Input
Output: JsonValue

Entity Owners

entityOwnersSchema

entityOwners.entityOwnersSchema Entity Owners schema (GET /entityOwners/schema) Risk: read
Input
Output

listEntityOwners

entityOwners.listEntityOwners List Entity Owners (GET /entityOwners) Risk: read
Input
Output: object[]

Events Tasks

calendarSchema

eventsTasks.calendarSchema Calendar schema (GET /calendar/schema) Risk: read
Input
Output

createCalendar

eventsTasks.createCalendar Create Calendar (POST /calendar) Risk: destructive
Input With sendNotification true, ForceManager emails an invitation to the event’s contacts. Leave it unset or false unless the contacts should be invited.
Output

deleteCalendar

eventsTasks.deleteCalendar Delete Calendar (DELETE /calendar/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getCalendar

eventsTasks.getCalendar Get Calendar (GET /calendar/{ID}) Risk: read
Input
Output

listCalendar

eventsTasks.listCalendar List Calendar (GET /calendar) Risk: read
Input
Output: object[]

updateCalendar

eventsTasks.updateCalendar Update Calendar (PUT /calendar/{ID}) Risk: destructive
Input With sendNotification true, ForceManager emails an invitation to the event’s contacts. Leave it unset or false unless the contacts should be invited.
Output

Extra Fields Entity

createExtraFieldForResource

extraFieldsEntity.createExtraFieldForResource Create Extra Field for Resource (POST /extrafields/VALUE) Risk: write
Input
Output

extraFieldsSchemaByResource

extraFieldsEntity.extraFieldsSchemaByResource Extra Fields schema by Resource (GET /extrafields/VALUE/schema) Risk: read
Input
Output

listExtraFieldsByResource

extraFieldsEntity.listExtraFieldsByResource List Extra Fields by Resource (GET /extrafields/VALUE) Risk: read
Input
Output: object[]

Extra Fields Tabs

createTabs

extraFieldsTabs.createTabs Create Tabs (POST /extrafieldsTabs) Risk: write
Input
Output

deleteTabs

extraFieldsTabs.deleteTabs Delete Tabs (DELETE /extrafieldsTabs/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getTabs

extraFieldsTabs.getTabs Get Tabs (GET /extrafieldsTabs/{ID}) Risk: read
Input
Output: string

listTabs

extraFieldsTabs.listTabs List Tabs (GET /extrafieldsTabs) Risk: read
Input
Output: object[]

updateTabs

extraFieldsTabs.updateTabs Update Tabs (PUT /extrafieldsTabs/{ID}) Risk: write
Input
Output

Forms Entity

getForm

formsEntity.getForm Get Form (GET /forms/{ID}) Risk: read
Input
Output

Forms States

getFormState

formsStates.getFormState Get Form State (GET /forms/{ID}/state) Risk: read
Input
Output

Forms Templates

getFormTemplate

formsTemplates.getFormTemplate Get Form Template (GET /forms/{ID}/template) Risk: read
Input
Output

News

listNews

news.listNews List News (GET /news) Risk: read
Input
Output: object[]

Opportunities Entity

createOpportunity

opportunitiesEntity.createOpportunity Create Opportunity (POST /opportunities) Risk: write
Input
Output

deleteOpportunity

opportunitiesEntity.deleteOpportunity Delete Opportunity (DELETE /opportunities/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getOpportunity

opportunitiesEntity.getOpportunity Get Opportunity (GET /opportunities/{ID}) Risk: read
Input
Output

listOpportunities

opportunitiesEntity.listOpportunities List Opportunities (GET /opportunities) Risk: read
Input
Output: object[]

opportunitiesSchema

opportunitiesEntity.opportunitiesSchema Opportunities schema (GET /opportunities/schema) Risk: read
Input
Output

updateOpportunity

opportunitiesEntity.updateOpportunity Update Opportunity (PUT /opportunities/{ID}) Risk: write
Input
Output

Opportunities Statuses

createOpportunityStatus

opportunitiesStatuses.createOpportunityStatus Create Opportunity Status (POST /opportunityStatuses) Risk: write
Input
Output

deleteOpportunityStatus

opportunitiesStatuses.deleteOpportunityStatus Delete Opportunity Status (DELETE /opportunityStatuses/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getOpportunityStatus

opportunitiesStatuses.getOpportunityStatus Get Opportunity Status (GET /opportunityStatuses/{ID}) Risk: read
Input
Output

listOpportunityStatuses

opportunitiesStatuses.listOpportunityStatuses List Opportunity Statuses (GET /opportunityStatuses) Risk: read
Input
Output: object[]

opportunityStatusesSchema

opportunitiesStatuses.opportunityStatusesSchema Opportunity Statuses schema (GET /opportunityStatuses/schema) Risk: read
Input
Output

updateOpportunityStatus

opportunitiesStatuses.updateOpportunityStatus Update Opportunity Status (PUT /opportunityStatuses/{ID}) Risk: write
Input
Output

Opportunities Types

createOpportunityType

opportunitiesTypes.createOpportunityType Create Opportunity Type (POST /opportunityTypes) Risk: write
Input
Output

deleteOpportunityType

opportunitiesTypes.deleteOpportunityType Delete Opportunity Type (DELETE /opportunityTypes/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getOpportunityTypes

opportunitiesTypes.getOpportunityTypes Get Opportunity Types (GET /opportunityTypes/{ID}) Risk: read
Input
Output

listOpportunityTypes

opportunitiesTypes.listOpportunityTypes List Opportunity Types (GET /opportunityTypes) Risk: read
Input
Output: string

opportunityTypesSchema

opportunitiesTypes.opportunityTypesSchema Opportunity Types schema (GET /opportunityTypes/schema) Risk: read
Input
Output

updateOpportunityType

opportunitiesTypes.updateOpportunityType Update Opportunity Type (PUT /opportunityTypes/{ID}) Risk: write
Input
Output

Orders Entity

createOrderHeader

ordersEntity.createOrderHeader Create Order Header (POST /salesorders) Risk: write
Input
Output

createOrderLine

ordersEntity.createOrderLine Create Order Line (POST /salesOrdersLines) Risk: write
Input
Output

deleteOrderHeader

ordersEntity.deleteOrderHeader Delete Order Header (DELETE /salesorders/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

deleteOrderLine

ordersEntity.deleteOrderLine Delete Order Line (DELETE /salesordersLines/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getOrderHeader

ordersEntity.getOrderHeader Get Order Header (GET /salesorders/{ID}) Risk: read
Input
Output

getOrderLine

ordersEntity.getOrderLine Get Order Line (GET /salesordersLines/{ID}) Risk: read
Input
Output

listOrderHeaders

ordersEntity.listOrderHeaders List Order Headers (GET /salesorders) Risk: read
Input
Output: object[]

listOrderLines

ordersEntity.listOrderLines List Order Lines (GET /salesordersLines) Risk: read
Input
Output: object[]

orderHeadersSchema

ordersEntity.orderHeadersSchema Order Headers schema (GET /salesorders/schema) Risk: read
Input
Output

orderLinesSchema

ordersEntity.orderLinesSchema Order Lines schema (GET /salesordersLines/schema) Risk: read
Input
Output

updateOrderHeader

ordersEntity.updateOrderHeader Update Order Header (PUT /salesorders/{ID}) Risk: write
Input
Output

updateOrderLine

ordersEntity.updateOrderLine Update Order Line (PUT /salesordersLines/{ID}) Risk: write
Input
Output

Orders Statuses

createOrderStatus

ordersStatuses.createOrderStatus Create Order Status (POST /salesorderStatuses) Risk: write
Input
Output

deleteOrderStatus

ordersStatuses.deleteOrderStatus Delete Order Status (DELETE /salesorderStatuses/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getOrderStatus

ordersStatuses.getOrderStatus Get Order Status (GET /salesorderStatuses/{ID}) Risk: read
Input
Output

listOrderStatuses

ordersStatuses.listOrderStatuses List Order Statuses (GET /salesorderStatuses) Risk: read
Input
Output: object[]

orderStatusesSchema

ordersStatuses.orderStatusesSchema Order Statuses schema (GET /salesorderStatuses/schema) Risk: read
Input
Output

updateOrderStatus

ordersStatuses.updateOrderStatus Update Order Status (PUT /salesorderStatuses/{ID}) Risk: write
Input
Output

Orders Types

createOrderTypes

ordersTypes.createOrderTypes Create Order Types (POST /orderTypes) Risk: write
Input
Output

deleteOrderTypes

ordersTypes.deleteOrderTypes Delete Order Types (DELETE /orderTypes/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getOrderTypes

ordersTypes.getOrderTypes Get Order Types (GET /orderTypes/{ID}) Risk: read
Input
Output

listOrderTypes

ordersTypes.listOrderTypes List Order Types (GET /orderTypes) Risk: read
Input
Output: object[]

orderTypesSchema

ordersTypes.orderTypesSchema Order Types schema (GET /orderTypes/schema) Risk: read
Input
Output

updateOrderTypes

ordersTypes.updateOrderTypes Update Order Types (PUT /orderTypes/{ID}) Risk: write
Input
Output

Product Environments

createProductEnvironment

productEnvironments.createProductEnvironment Create Product Environment (POST /productEnvironments) Risk: write
Input
Output

deleteProductEnvironment

productEnvironments.deleteProductEnvironment Delete Product Environment (DELETE /productEnvironments/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getProductEnvironment

productEnvironments.getProductEnvironment Get Product Environment (GET /productEnvironments/{ID}) Risk: read
Input
Output

listProductEnvironments

productEnvironments.listProductEnvironments List Product Environments (GET /productEnvironments) Risk: read
Input
Output: object[]

productEnvironmentsSchema

productEnvironments.productEnvironmentsSchema Product Environments schema (GET /productEnvironments/schema) Risk: read
Input
Output

updateProductEnvironment

productEnvironments.updateProductEnvironment Update Product Environment (PUT /productEnvironments/{ID}) Risk: write
Input
Output

Product Families Branches

createProductFamiliesBranch

productFamiliesBranches.createProductFamiliesBranch Create Product Families Branch (POST /productFamiliesBranches) Risk: write
Input
Output

deleteProductFamiliesBranch

productFamiliesBranches.deleteProductFamiliesBranch Delete Product Families Branch (DELETE /productFamiliesBranches/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getProductFamiliesBranch

productFamiliesBranches.getProductFamiliesBranch Get Product Families Branch (GET /productFamiliesBranches/{ID}) Risk: read
Input
Output

listProductFamiliesBranches

productFamiliesBranches.listProductFamiliesBranches List Product Families Branches (GET /productFamiliesBranches) Risk: read
Input
Output: object[]

productFamiliesBranchesSchema

productFamiliesBranches.productFamiliesBranchesSchema Product Families Branches schema (GET /productFamiliesBranches/schema) Risk: read
Input
Output

updateProductFamiliesBranch

productFamiliesBranches.updateProductFamiliesBranch Update Product Families Branch (PUT /productFamiliesBranches/{ID}) Risk: write
Input
Output

deletePicture

productsCarousel.deletePicture Delete Picture (DELETE /documents/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

Products Categories

createProductCategory

productsCategories.createProductCategory Create Product Category (POST /productCategories) Risk: write
Input
Output

deleteProductCategory

productsCategories.deleteProductCategory Delete Product Category (DELETE /productCategories/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getProductCategory

productsCategories.getProductCategory Get Product Category (GET /productCategories/{ID}) Risk: read
Input
Output

listProductCategories

productsCategories.listProductCategories List Product Categories (GET /productCategories) Risk: read
Input
Output: object[]

productCategoriesSchema

productsCategories.productCategoriesSchema Product Categories schema (GET /productCategories/schema) Risk: read
Input
Output

updateProductCategory

productsCategories.updateProductCategory Update Product Category (PUT /productCategories/{ID}) Risk: write
Input
Output

Products Entity

bulkCreateProducts

productsEntity.bulkCreateProducts Bulk Create Products (POST /products/bulk) Risk: write
Input
Output: object[]

bulkDeleteProducts

productsEntity.bulkDeleteProducts Bulk Delete Products (DELETE /products/bulk) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output: object[]

bulkUpdateProducts

productsEntity.bulkUpdateProducts Bulk Update Products (PUT /products/bulk) Risk: write
Input
Output: object[]

createProduct

productsEntity.createProduct Create Product (POST /products) Risk: write
Input
Output

deleteProduct

productsEntity.deleteProduct Delete Product (DELETE /products/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getProduct

productsEntity.getProduct Get Product (GET /products/{ID}) Risk: read
Input
Output

listProducts

productsEntity.listProducts List Products (GET /products) Risk: read
Input
Output: object[]

productsSchema

productsEntity.productsSchema Products schema (GET /products/schema) Risk: read
Input
Output

updateProduct

productsEntity.updateProduct Update Product (PUT /products/{ID}) Risk: write
Input
Output

Products Families

createProductFamily

productsFamilies.createProductFamily Create Product Family (POST /productFamilies) Risk: write
Input
Output

getProductFamily

productsFamilies.getProductFamily Get Product Family (GET /productFamilies/{ID}) Risk: read
Input
Output

listProductFamilies

productsFamilies.listProductFamilies List Product Families (GET /productFamilies) Risk: read
Input
Output: object[]

productFamiliesSchema

productsFamilies.productFamiliesSchema Product Families schema (GET /productFamilies/schema) Risk: read
Input
Output

updateProductFamily

productsFamilies.updateProductFamily Update Product Family (PUT /productFamilies/{ID}) Risk: write
Input
Output

Products Rates

createProductRate

productsRates.createProductRate Create Product Rate (POST /productRates) Risk: write
Input
Output

deleteProductRate

productsRates.deleteProductRate Delete Product Rate (DELETE /productRates/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getProductRate

productsRates.getProductRate Get Product Rate (GET /productRates/{ID}) Risk: read
Input
Output

listProductRates

productsRates.listProductRates List Product Rates (GET /productRates) Risk: read
Input
Output: JsonValue

productRatesSchema

productsRates.productRatesSchema Product Rates schema (GET /productRates/schema) Risk: read
Input
Output

updateProductRate

productsRates.updateProductRate Update Product Rate (PUT /productRates/{ID}) Risk: write
Input
Output

Product Units Of Measure

createProductUnitOfMeasure

productUnitsOfMeasure.createProductUnitOfMeasure Create Product Unit Of Measure (POST /productUnitsOfMeasure) Risk: write
Input
Output

deleteProductUnitOfMeasure

productUnitsOfMeasure.deleteProductUnitOfMeasure Delete Product Unit Of Measure (DELETE /productUnitsOfMeasure/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getProductUnitOfMeasure

productUnitsOfMeasure.getProductUnitOfMeasure Get Product Unit Of Measure (GET /productUnitsOfMeasure/{ID}) Risk: read
Input
Output

listProductUnitsOfMeasure

productUnitsOfMeasure.listProductUnitsOfMeasure List Product Units Of Measure (GET /productUnitsOfMeasure) Risk: read
Input
Output: object[]

productUnitsOfMeasureSchema

productUnitsOfMeasure.productUnitsOfMeasureSchema Product Units Of Measure schema (GET /productUnitsOfMeasure/schema) Risk: read
Input
Output

updateProductUnitOfMeasure

productUnitsOfMeasure.updateProductUnitOfMeasure Update Product Unit Of Measure (PUT /productUnitsOfMeasure/{ID}) Risk: write
Input
Output

Rates

createRate

rates.createRate Create Rate (POST /rates) Risk: write
Input
Output

deleteRate

rates.deleteRate Delete Rate (DELETE /rates/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getRate

rates.getRate Get Rate (GET /rates/{ID}) Risk: read
Input
Output

listRates

rates.listRates List Rates (GET /rates) Risk: read
Input
Output: object[]

ratesSchema

rates.ratesSchema Rates schema (GET /rates/schema) Risk: read
Input
Output

updateRate

rates.updateRate Update Rate (PUT /rates/{ID}) Risk: write
Input
Output

createRelatedAccount

relatedAccountsEntity.createRelatedAccount Create Related Account (POST /accountsRelated) Risk: write
Input
Output

deleteRelatedAccount

relatedAccountsEntity.deleteRelatedAccount Delete Related Account (DELETE /accountsRelated/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

listRelatedAccounts

relatedAccountsEntity.listRelatedAccounts List Related Accounts (GET /accountsRelated) Risk: read
Input
Output: object[]

relatedAccountsSchema

relatedAccountsEntity.relatedAccountsSchema Related Accounts schema (GET /accountsRelated/schema) Risk: read
Input
Output

retrieveRelatedAccount

relatedAccountsEntity.retrieveRelatedAccount Retrieve Related Account (GET /accountsRelated/{ID}) Risk: read
Input
Output

updateRelatedAccount

relatedAccountsEntity.updateRelatedAccount Update Related Account (PUT /accountsRelated/{ID}) Risk: write
Input
Output

createRelatedAccountType

relatedAccountsTypes.createRelatedAccountType Create Related Account Type (POST /accountsRelations) Risk: write
Input
Output

deleteRelatedAccountType

relatedAccountsTypes.deleteRelatedAccountType Delete Related Account Type (DELETE /accountsRelations/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

listRelatedAccountTypes

relatedAccountsTypes.listRelatedAccountTypes List Related Account Types (GET /accountsRelations) Risk: read
Input
Output: object[]

relatedAccountTypesSchema

relatedAccountsTypes.relatedAccountTypesSchema Related Account Types schema (GET /accountsRelations/schema) Risk: read
Input
Output

retrieveRelatedAccountType

relatedAccountsTypes.retrieveRelatedAccountType Retrieve Related Account Type (GET /accountsRelations/{ID}) Risk: read
Input
Output

updateRelatedAccountType

relatedAccountsTypes.updateRelatedAccountType Update Related Account Type (PUT /accountsRelations/{ID}) Risk: write
Input
Output

Resources

getResources

resources.getResources Get Resources (GET /resources) Risk: read
Input
Output: object[]

Roles

addRolesInUser

roles.addRolesInUser Add Roles in User (PUT /users/{ID}/roles) Risk: write
Input
Output: object[]

deleteRolesInUser

roles.deleteRolesInUser Delete Roles in User (DELETE /users/{ID}/roles) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output: object[]

getRole

roles.getRole Get Role (GET /roles/{ID}) Risk: read
Input
Output

listRoles

roles.listRoles List Roles (GET /roles) Risk: read
Input
Output: object[]

listRolesOfUser

roles.listRolesOfUser List Roles of User (GET /users/{ID}/roles) Risk: read
Input
Output: object[]

listUsersInRole

roles.listUsersInRole List Users in Role (GET /roles/{ID}/users) Risk: read
Input
Output: object[]

rolesSchema

roles.rolesSchema Roles schema (GET /roles/schema) Risk: read
Input
Output

Sales

createSale

sales.createSale Create Sale (POST /sales) Risk: write
Input
Output

deleteSale

sales.deleteSale Delete Sale (DELETE /sales/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getSale

sales.getSale Get Sale (GET /sales/{ID}) Risk: read
Input
Output

listSales

sales.listSales List Sales (GET /sales) Risk: read
Input
Output: object[]

salesSchema

sales.salesSchema Sales schema (GET /sales/schema) Risk: read
Input
Output

updateSale

sales.updateSale Update Sale (PUT /sales/{ID}) Risk: write
Input
Output

Tax Profiles

getTaxProfile

taxProfiles.getTaxProfile Get Tax Profile (GET /taxProfiles/{ID}) Risk: read
Input
Output

listTaxProfiles

taxProfiles.listTaxProfiles List Tax Profiles (GET /taxProfiles) Risk: read
Input
Output: object[]

taxProfilesSchema

taxProfiles.taxProfilesSchema Tax Profiles schema (GET /taxProfiles/schema) Risk: read
Input
Output

Tax Rates

createTaxRate

taxRates.createTaxRate Create Tax Rate (POST /taxRates) Risk: write
Input
Output

deleteTaxRate

taxRates.deleteTaxRate Delete Tax Rate (DELETE /taxRates/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getTaxRate

taxRates.getTaxRate Get Tax Rate (GET /taxRates/{ID}) Risk: read
Input
Output

listTaxRates

taxRates.listTaxRates List Tax Rates (GET /taxRates) Risk: read
Input
Output: object[]

taxRatesSchema

taxRates.taxRatesSchema Tax Rates schema (GET /taxRates/schema) Risk: read
Input
Output

updateTaxRate

taxRates.updateTaxRate Update Tax Rate (PUT /taxRates/{ID}) Risk: write
Input
Output

Time Zones

listTimezones

timeZones.listTimezones List TimeZones (GET /timezones) Risk: read
Input
Output: object[]

Units Of Measure

createUnitOfMeasure

unitsOfMeasure.createUnitOfMeasure Create Unit Of Measure (POST /unitsOfMeasure) Risk: write
Input
Output

deleteUnitOfMeasure

unitsOfMeasure.deleteUnitOfMeasure Delete Unit Of Measure (DELETE /unitsOfMeasure/{ID}) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

getUnitOfMeasure

unitsOfMeasure.getUnitOfMeasure Get Unit Of Measure (GET /unitsOfMeasure/{ID}) Risk: read
Input
Output

listUnitsOfMeasure

unitsOfMeasure.listUnitsOfMeasure List Units Of Measure (GET /unitsOfMeasure) Risk: read
Input
Output: object[]

unitsOfMeasureSchema

unitsOfMeasure.unitsOfMeasureSchema Units Of Measure schema (GET /unitsOfMeasure/schema) Risk: read
Input
Output

updateUnitOfMeasure

unitsOfMeasure.updateUnitOfMeasure Update Unit Of Measure (PUT /unitsOfMeasure/{ID}) Risk: write
Input
Output

Users Entity

createUser

usersEntity.createUser Create User (POST /users) Risk: destructive
Input Creates a user who can sign in. An active user can take a paid seat; the response’s billable field says whether ForceManager bills for it.
Output

deleteUser

usersEntity.deleteUser Delete User (DELETE /users/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getUser

usersEntity.getUser Get User (GET /users/{ID}) Risk: read
Input
Output

listUserHierarchy

usersEntity.listUserHierarchy List User Hierarchy (GET /users/{ID}/hierarchy) Risk: read
Input
Output: object[]

listUsers

usersEntity.listUsers List Users (GET /users) Risk: read
Input
Output: object[]

listUsersScores

usersEntity.listUsersScores List Users Scores (GET /users/scores) Risk: read
Input
Output: object[]

updateUser

usersEntity.updateUser Update User (PUT /users/{ID}) Risk: destructive
Input Changes extId and isActive only. isActive true lets the user sign in and can take a paid seat; the response’s billable field says whether ForceManager bills for it.
Output

usersSchema

usersEntity.usersSchema Users schema (GET /users/schema) Risk: read
Input
Output

Users Types

createUserType

usersTypes.createUserType Create User Type (POST /userTypes) Risk: write
Input
Output

getUserType

usersTypes.getUserType Get User Type (GET /userTypes/{ID}) Risk: read
Input
Output

listUserTypes

usersTypes.listUserTypes List User Types (GET /userTypes) Risk: read
Input
Output: object[]

updateUserType

usersTypes.updateUserType Update User Type (PUT /userTypes/{ID}) Risk: write
Input
Output

userTypesSchema

usersTypes.userTypesSchema User Types schema (GET /userTypes/schema) Risk: read
Input
Output

Value Lists Entity

createList

valueListsEntity.createList Create List (POST /list) Risk: write
Input
Output

deleteList

valueListsEntity.deleteList Delete List (DELETE /list/VALUE) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

listLists

valueListsEntity.listLists List Lists (GET /list) Risk: read
Input
Output: object[]

updateList

valueListsEntity.updateList Update List (PUT /list/VALUE) Risk: write
Input
Output

Value Lists Values

createValue

valueListsValues.createValue Create Value (POST /list/VALUE) Risk: write
Input
Output

deleteValue

valueListsValues.deleteValue Delete Value (DELETE /list/VALUE/{ID}) Risk: destructive
Input Deletes the selected record permanently or archives it per ForceManager resource behavior; review the target ID before calling.
Output

getValue

valueListsValues.getValue Get Value (GET /list/VALUE/{ID}) Risk: read
Input
Output

listValues

valueListsValues.listValues List Values (GET /list/VALUE) Risk: read
Input
Output: object[]

updateValue

valueListsValues.updateValue Update Value (PUT /list/VALUE/{ID}) Risk: write
Input
Output

valuesListSchema

valueListsValues.valuesListSchema Values List schema (GET /list/VALUE/schema) Risk: read
Input
Output

Warnings

createWarningForAResourceCopy

warnings.createWarningForAResourceCopy Create Warning for a Resource Copy (POST /VALUE/VALUE/warnings) Risk: write
Input
Output

deleteWarningOfAResource

warnings.deleteWarningOfAResource Delete Warning of a Resource (DELETE /VALUE/VALUE/warnings/VALUE) Risk: destructive
Input Review the target identifier and business impact before deleting this ForceManager record.
Output

listWarningsOfAResource

warnings.listWarningsOfAResource List Warnings of a Resource (GET /VALUE/VALUE/warnings) Risk: read
Input
Output: object[]

updateWarningOfAResource

warnings.updateWarningOfAResource Update Warning of a Resource (PUT /VALUE/VALUE/warnings/VALUE) Risk: write
Input
Output