ForceManager
BUSINESS · CRM & SUPPORT
Accounts, contacts, opportunities, and sales activity in the CRM they connected.
Acts as the person, not as itself
Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.
Credentials never touch the agent
Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.
Every call on the record
Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.
What an agent can do
Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.
forcemanager_delete_accountaddresses_by_idWRITEDelete Account Address via DELETE /accountAddresses/{account_address_id}. This endpoint allows you to delete a specific Account Address from the user's ForceManager implementation database. If the specified Account Address does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_accounts_by_idWRITEDelete Account via DELETE /accounts/{account_id}. This endpoint allows you to delete a specific Account from the user's ForceManager implementation database. If the specified Account does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_accountsegments_by_idWRITEDelete Account Segment via DELETE /accountSegments/{account_segment_id}. This endpoint allows you to delete a specific Account Segment from the user's ForceManager implementation database. If the specified Account Segment does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_accountsrelated_by_idWRITEDelete Related Account via DELETE /accountsRelated/{related_account_id}. This endpoint allows you to delete a specific Related Account from the user's ForceManager implementation database. If the specified Related Account does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_accountsrelations_by_idWRITEDelete Related Account Type via DELETE /accountsRelations/{related_account_type_id}. This endpoint allows you to delete a specific Related Account Type from the user's ForceManager implementation database. If the specified Related Account Type does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_accountstatuses_by_idWRITEDelete Account Status via DELETE /accountStatuses/{account_status_id}. This endpoint allows you to delete a specific Account Status from the user's ForceManager implementation database. If the specified Account Status does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_activities_by_idWRITEDelete Activity via DELETE /activities/{activity_id}. This endpoint allows you to delete a specific Activity from the user's ForceManager implementation database. If the specified Activity does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_activitytypes_by_idWRITEDelete Activity Type via DELETE /activityTypes/{activity_type_id}. This endpoint allows you to delete a specific Activity Type from the user's ForceManager implementation database. If the specified Activity Type does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_branches_by_idWRITEDelete Branch via DELETE /branches/{branch_id}. This endpoint allows you to delete a specific Branch from the Value List. If the specified Branch does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_calendar_by_idWRITEDelete Calendar via DELETE /calendar/{calendar_entry_id}. This endpoint allows you to delete a specific calendar Event or Task from the user's ForceManager implementation database. If the specified calendar Event or Task does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_calls_by_idWRITEDelete Call via DELETE /calls/{call_id}. This endpoint allows you to delete a specific Call from the user's ForceManager implementation database. If the specified Call does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_campaignquestions_by_idWRITEDelete Campaign Question via DELETE /campaignQuestions/{question_id}. This endpoint allows you to delete a specific Campaign Question from the user's ForceManager implementation database. If the specified Campaign Question does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_campaignquestions_by_id_answers_by_idWRITEDelete Question Answer via DELETE /campaignQuestions/{question_id}/answers/{answer_id}. This endpoint allows you to delete a specific Campaign Question Answer from the user's ForceManager implementation database. If the specified Campaign Question Answer does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_campaignquestions_by_id_values_by_idWRITEDelete Question Value via DELETE /campaignQuestions/{question_id}/values/{value_id}. This endpoint allows you to delete a specific Campaign Question Value from the user's ForceManager implementation database. If the specified Campaign Question Value does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_campaigns_by_idWRITEDelete Campaign via DELETE /campaigns/{campaign_id}. This endpoint allows you to delete a specific Campaign from the user's ForceManager implementation database. If the specified Campaign does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_campaigns_by_id_entities_by_entity_idWRITEDelete Campaign Account via DELETE /campaigns/{campaign_id}/entities/{entity_id}. This endpoint allows you to delete a specific Campaign Account from the user's ForceManager implementation database. If the specified Campaign Account does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_contacts_by_idWRITEDelete Contact via DELETE /contacts/{contact_id}. This endpoint allows you to delete a specific Contact from the user's ForceManager account database. If the specified Contact does not exist, the response will be a "bad request". This operation cannot be undone. <br>
forcemanager_delete_contacttypes_by_idWRITEDelete Contact Type via DELETE /contactTypes/{contact_type_id}. This endpoint allows you to delete a specific Contact Type from the user's ForceManager implementation database. If the specified Contact Type does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_documents_by_idWRITEDelete Picture via DELETE /documents/{document_id}. This endpoint allows you to delete a specific Picture from the user's ForceManager implementation database. If the specified Picture does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_extrafieldstabs_by_idWRITEDelete Tabs via DELETE /extrafieldsTabs/{tab_id}. This endpoint allows you to delete a specific Tab from the user's ForceManager implementation database. If the specified Tab does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_hooks_by_idWRITEDelete Webhook via DELETE /hooks/{webhook_id}. This endpoint allows you to delete a specific Webhook from the user's ForceManager implementation database. If the specified Webhook does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_list_accounttypes_by_idWRITEDelete Account Type via DELETE /list/accountTypes/{account_type_id}. This endpoint allows you to delete a specific Account Type from the user's ForceManager implementation database. If the specified Account Type does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_list_by_nameWRITEDelete List via DELETE /list/{list_name}. This endpoint allows you to delete a specific List. If the specified List does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_list_by_name_by_idWRITEDelete Value via DELETE /list/{list_name}/{value_id}. This endpoint allows you to delete a specific Value from a Value List. If the specified Value does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_opportunities_by_idWRITEDelete Opportunity via DELETE /opportunities/{opportunity_id}. This endpoint allows you to delete a specific Opportunity from the user's ForceManager implementation database. If the specified Opportunity does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_opportunitystatuses_by_idWRITEDelete Opportunity Status via DELETE /opportunityStatuses/{opportunity_status_id}. This endpoint allows you to delete a specific Opportunity Status from the user's ForceManager implementation database. If the specified Opportunity Status does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_opportunitytypes_by_idWRITEDelete Opportunity Type via DELETE /opportunityTypes/{opportunity_type_id}. This endpoint allows you to delete a specific Opportunity Type from the user's ForceManager implementation database. If the specified Opportunity Type does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_ordertypes_by_idWRITEDelete Order Types via DELETE /orderTypes/{order_type_id}. This endpoint allows you to delete a specific Order Types from the user's ForceManager implementation database. If the specified Order Types does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_productcategories_by_idWRITEDelete Product Category via DELETE /productCategories/{product_category_id}. This endpoint allows you to delete a specific Product Category. If the specified Product Category does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_productfamilies_by_idWRITEDelete Product Family via DELETE /productFamilies/{product_family_id}. This endpoint allows you to delete a specific Product Family. If the specified Product Family does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_productrates_by_idWRITEDelete Product Rate via DELETE /productRates/{product_rate_id}. This endpoint allows you to delete a specific Product Rate. If the specified Product Rate does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_products_bulkWRITEBulk Delete Products via DELETE /products/bulk. This endpoint allows you to delete Multiple Products (100 entities for request) from the user's ForceManager implementation database. If the specified Account does not exist, the response will be a "bad request". This operation cannot be undone. Send an ARRAY of `{guid, id}` objects -- authored from the vendor's REQUEST prose, because the contract declares no requestBody here, and unverified against the live API. Cap 100 entities per request; one result row per `guid`.
forcemanager_delete_products_by_idWRITEDelete Product via DELETE /products/{product_id}. This endpoint allows you to delete a specific Product from the user's ForceManager implementation database. If the specified Product does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_rates_by_idWRITEDelete Rate via DELETE /rates/{rate_id}. This endpoint allows you to delete a specific Rate from the user's ForceManager implementation database. If the specified Rate does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_resource_bulkWRITEBulk Delete Resources via DELETE /{resource}/bulk. This endpoint allows you to delete multiple Resources (120 entities for request) from the user's ForceManager implementation database. If the specified Resource does not exist, the response will be a "bad request". This operation cannot be undone. Send an ARRAY of `{guid, id}` objects -- authored from the vendor's REQUEST prose, because the contract declares no requestBody here, and unverified against the live API. Cap 120 entities per request; one result row per `guid`. `resource` is the entity name in the first path segment; the vendor documents Accounts, Contacts, Opportunities, Orders and Value Lists are the examples the vendor gives ('e.g.'), so the list is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged.
forcemanager_delete_resource_warnings_by_idWRITEDelete Warning of a Resource via DELETE /{resource}/{resource_id}/warnings/{warning_id}. This endpoint allows you to delete a Warning of a specific Resource (accounts, opportunities, products, salesorders) based on JSON input. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `products`, `salesorders`. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status. This operation cannot be undone.
forcemanager_delete_sales_by_idWRITEDelete Sale via DELETE /sales/{sale_id}. This endpoint allows you to delete a specific Sale from the user's ForceManager implementation database. If the specified Sale does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_salesorders_by_idWRITEDelete Order Header via DELETE /salesorders/{order_id}. This endpoint allows you to delete a specific Order Header from the user's ForceManager implementation database. If the specified Order Header does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_salesorderslines_by_idWRITEDelete Order Line via DELETE /salesordersLines/{order_line_id}. This endpoint allows you to delete a specific Order Line from the user's ForceManager implementation database. If the specified Order Line does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_salesorderstatuses_by_idWRITEDelete Order Status via DELETE /salesorderStatuses/{order_status_id}. This endpoint allows you to delete a specific Order Status from the user's ForceManager implementation database. If the specified Order Status does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_users_by_idWRITEDelete User via DELETE /users/{user_id}. This endpoint allows you to delete a specific User from the user's ForceManager account database. If the specified User does not exist, the response will be a "bad request". This operation cannot be undone. <br>
forcemanager_delete_users_by_id_rolesWRITEDelete Roles in User via DELETE /users/{user_id}/roles. This endpoint allows you to delete a specific User's Role from the user's ForceManager account database. If the specified User's Role does not exist, the response will be a "bad request". This operation cannot be undone.
forcemanager_delete_usertypes_by_idWRITEDelete User Type via DELETE /userTypes/{user_type_id}. Deletes one User Type by its integer id. If the specified User Type does not exist, the response is a bad request. This operation cannot be undone.
forcemanager_get_accountaddressesREADList Account Addresses via GET /accountAddresses. Returns all Account Addresses available in the user's ForceManager implementation database.
forcemanager_get_accountaddresses_by_idREADGet Account Address via GET /accountAddresses/{account_address_id}. This endpoint retrieves data of a specific Account Address based on JSON input. The API returns a single Address available to the user, according to the unique ID provided. If the specified Account Address does not exist, the response will be a "bad request".
forcemanager_get_accountaddresses_schemaREADAccount Addresses schema via GET /accountAddresses/schema. The Schema is metadata that tells you how the data is structured for this specific Value list.
forcemanager_get_accountsREADList Accounts via GET /accounts. Returns all Accounts available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_accounts_by_idREADGet Account via GET /accounts/{account_id}. This endpoint retrieves data of a specific Account based on JSON input. The API returns a single Account available to the user, according to the unique ID provided. If the specified Account does not exist, the response will be a "bad request". `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_accounts_schemaREADAccounts schema via GET /accounts/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for an Account object.
forcemanager_get_accountsegmentsREADList Account Segments via GET /accountSegments. Returns all Account Segments available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_accountsegments_by_idREADGet Account Segment via GET /accountSegments/{account_segment_id}. This endpoint retrieves data of a specific Account Segment based on JSON input. The API returns a single Account Segment available to the user in the Value List, according to the unique ID provided. If the specified Account Segment does not exist, the response will be a "bad request".
forcemanager_get_accountsegments_schemaREADAccount Segments schema via GET /accountSegments/schema. Returns properties object with the definition of each field in the Account Segment table. With the Account Segment you can differentiate the Account based on specific visit cycles, hence assigning a priority to each Account.
forcemanager_get_accountsrelatedREADList Related Accounts via GET /accountsRelated. Returns all Related Accounts available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_accountsrelated_by_idREADRetrieve Related Account via GET /accountsRelated/{related_account_id}. This endpoint retrieves data of a specific Related Account based on JSON input. The API returns a single Related Account available to the user, according to the unique ID provided. If the specified Related Account does not exist, the response will be a "bad request".
forcemanager_get_accountsrelated_schemaREADRelated Accounts schema via GET /accountsRelated/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Related Account object.
forcemanager_get_accountsrelationsREADList Related Account Types via GET /accountsRelations. Returns all Related Account Types available, based on JSON input. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_accountsrelations_by_idREADRetrieve Related Account Type via GET /accountsRelations/{related_account_type_id}. This endpoint retrieves data of a specific Related Account Type based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Related Account Type does not exist, the response will be a "bad request".
forcemanager_get_accountsrelations_schemaREADRelated Account Types schema via GET /accountsRelations/schema. Returns properties object with the definition of each field in the Related Account Type table. With the Related Account Type you can differentiate the Type of Relation.
forcemanager_get_accountstatusesREADList Account Statuses via GET /accountStatuses. Returns all Account Statuses available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_accountstatuses_by_idREADGet Account Status via GET /accountStatuses/{account_status_id}. This endpoint retrieves data of a specific Account Status based on JSON input. The API returns a single Account Status available to the user in the Value List, according to the unique ID provided. If the specified Account Status does not exist, the response will be a "bad request".
forcemanager_get_accountstatuses_schemaREADAccount Statuses schema via GET /accountStatuses/schema. Returns properties object with the definition of each field in the Account Status table.
forcemanager_get_accounttypesREADList Account Types via GET /accountTypes. Returns all Account Types available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_accounttypes_by_idREADGet Account Type via GET /accountTypes/{account_type_id}. Returns one Account Type by its integer id. An Account Type carries its translated descriptions, its branch visibility, and the computeSfm and internal flags that decide whether it counts for sales analytics and whether it is for internal use only. The sealed contract documents this operation with a RESPONSE table and no prose of its own; this description is authored from that table. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_accounttypes_schemaREADAccount Types schema via GET /accountTypes/schema. Returns properties object with the definition of each field in the Account Type table.
forcemanager_get_activitiesREADList Activities via GET /activities. Returns all Activities available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_activities_by_idREADGet Activity via GET /activities/{activity_id}. This endpoint retrieves data of a specific Activity based on JSON input. The API returns a single Activity available to the user, according to the unique ID provided. If the specified Activity does not exist, the response will be a "bad request". `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_activities_schemaREADActivities schema via GET /activities/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for an Activity object.
forcemanager_get_activity_pointsREADList Activity Points via GET /activity/points. Returns all Activity Points available in the user's ForceManager implementation database.
forcemanager_get_activitytypesREADList Activity Types via GET /activityTypes. Returns all Activity Types available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_activitytypes_by_idREADGet Activity Type via GET /activityTypes/{activity_type_id}. This endpoint retrieves data of a specific Activity Type based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Activity Type does not exist, the response will be a "bad request".
forcemanager_get_activitytypes_schemaREADActivity Types schema via GET /activityTypes/schema. Returns properties object with the definition of each field in the Activity Type table. With the Activity Type you can differentiate the Type of Activity with which professional relationships are stablished.
forcemanager_get_branchesREADList Branches via GET /branches. Returns all Branches.
forcemanager_get_branches_by_idREADGet Branch via GET /branches/{branch_id}. This endpoint retrieves data of a specific Branch based on JSON input. The API returns a single Branch available to the user in the Value List, according to the unique ID provided. If the specified Branch does not exist, the response will be a "bad request".
forcemanager_get_branches_schemaREADBranches schema via GET /branches/schema. Returns properties object with the definition of each field in the Branches table.
forcemanager_get_calendarREADList Calendar via GET /calendar. Returns all Events and Tasks available in the user's ForceManager implementation database based on JSON input. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_calendar_by_idREADGet Calendar via GET /calendar/{calendar_entry_id}. This endpoint retrieves data of a specific calendar Event or Task based on JSON input. The API returns a single Type available to the user, according to the unique ID provided. If the specified calendar Event or Task does not exist, the response will be a "bad request". `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_calendar_schemaREADCalendar schema via GET /calendar/schema. The Schema is a metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Event/Task object. Returns properties object with the definition of each field in the Event/Task table.
forcemanager_get_callsREADList Calls via GET /calls. Returns all Calls available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_calls_by_idREADGet Call via GET /calls/{call_id}. This endpoint retrieves data of a specific Call based on JSON input. The API returns a single Call available to the user, according to the unique ID provided. If the specified Call does not exist, the response will be a "bad request".
forcemanager_get_calls_by_phoneREADGet Resources by Phone Number via GET /calls/phone/{phone_number}. Returns the ids of the Contacts, Accounts and Users associated with a specific phone number -- the vendor's own one-line account of this route, from the Calls API method table ('Get a list of Contacts, Accounts, Users IDs referred to a specific phone number'). It is a lookup, not a read of a Call: pass the phone number in the path. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_campaignquestionsREADList Campaign Questions via GET /campaignQuestions. Returns all Campaign Questions available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_campaignquestions_by_idREADGet Campaign Question via GET /campaignQuestions/{question_id}. This endpoint retrieves data of a specific Campaign Question based on JSON input. The API returns a single Campaign Question available to the user, according to the unique ID provided. If the specified Campaign Question does not exist, the response will be a "bad request".
forcemanager_get_campaignquestions_by_id_answersREADList Question Answers via GET /campaignQuestions/{question_id}/answers. Returns all Campaign Question Answers available in the user's ForceManager implementation database. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_campaignquestions_by_id_answers_by_idREADGet Question Answer via GET /campaignQuestions/{question_id}/answers/{answer_id}. This endpoint retrieves data of a specific Campaign Question Answer based on JSON input. The API returns a single Campaign Question Answer available to the user, according to the unique ID provided. If the specified Campaign Question Answer does not exist, the response will be a "bad request".
forcemanager_get_campaignquestions_by_id_valuesREADList Question Values via GET /campaignQuestions/{question_id}/values. Returns all Campaign Question Values available in the user's ForceManager implementation database. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_campaignquestions_by_id_values_by_idREADGet Question Value via GET /campaignQuestions/{question_id}/values/{value_id}. This endpoint retrieves data of a specific Campaign Question Value based on JSON input. The API returns a single Campaign Question Value available to the user, according to the unique ID provided. If the specified Campaign Question Value does not exist, the response will be a "bad request".
forcemanager_get_campaignsREADList Campaigns via GET /campaigns. Returns all Campaigns available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_campaigns_by_idREADGet Campaign via GET /campaigns/{campaign_id}. This endpoint retrieves data of a specific Campaign based on JSON input. The API returns a single Campaign available to the user, according to the unique ID provided. If the specified Campaign does not exist, the response will be a "bad request".
forcemanager_get_campaigns_by_id_entitiesREADList Campaign Accounts via GET /campaigns/{campaign_id}/entities. Returns all Campaign Accounts available in the user's ForceManager implementation database. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_campaigns_by_id_entities_by_entity_idREADGet Campaign Account via GET /campaigns/{campaign_id}/entities/{entity_id}. This endpoint retrieves data of a specific Campaign Account based on JSON input. The API returns a single Campaign Account available to the user, according to the unique ID provided. If the specified Campaign Account does not exist, the response will be a "bad request".
forcemanager_get_campaignstatusesREADList Campaign Statuses via GET /campaignStatuses. Returns all Campaign Statuses available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_contactsREADList Contacts via GET /contacts. Returns all Contacts available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_contacts_by_idREADGet Contact via GET /contacts/{contact_id}. This endpoint retrieves data of a specific Contact based on JSON input. The API returns a single Contact available to the user, according to the unique ID provided. If the specified Contact does not exist, the response will be a "bad request".
forcemanager_get_contacts_schemaREADContacts schema via GET /contacts/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Contact object.
forcemanager_get_contactsentitiesREADList Entity Contacts via GET /contactsEntities. Returns all Entity Contacts available. Entity Contacts are basically needed to associate more than one User to an Entity (e.g. the Opportunities with more than one sales rep).
forcemanager_get_contactsentities_schemaREADEntity Contacts schema via GET /contactsEntities/schema. Returns properties object with the definition of each field in the Entity Contacts table.
forcemanager_get_contacttypesREADList Contact Types via GET /contactTypes. Returns all Contact Types available in the user's ForceManager implementation database. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_contacttypes_by_idREADGet Contact Type via GET /contactTypes/{contact_type_id}. This endpoint retrieves data of a specific Contact Type based on JSON input. The API returns a single Contact Type available to the user in the Value List, according to the unique ID provided. If the specified Contact Type does not exist, the response will be a "bad request".
forcemanager_get_contacttypes_schemaREADContact Types schema via GET /contactTypes/schema. Returns properties object with the definition of each field in the Contact Types table.
forcemanager_get_countriesREADList Countries via GET /countries. Returns all Countries available. Countries are basically needed for the geolocalized data (e.g. Accounts, Opportunities, Activities) in which a full address need to be specified.
forcemanager_get_countries_schemaREADCountries schema via GET /countries/schema. Returns properties object with the definition of each field in the Countries table.
forcemanager_get_currenciesREADList Currencies via GET /currencies. Returns all Currencies available. Currencies are needed for defining the measurement unit of the Opportunities.
forcemanager_get_currencies_schemaREADCurrencies schema via GET /currencies/schema. Returns properties object with the definition of each field in the Currencies table.
forcemanager_get_documentsREADList Documents via GET /documents. Returns all Documents available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_documents_foldersREADList Folders via GET /documents/folders. Returns all Folders available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_emailsREADList Emails via GET /emails. Returns all Emails available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_emails_by_idREADGet Email via GET /emails/{email_id}. This endpoint retrieves data of a specific Email based on JSON input. The API returns a single Email available to the user, according to the unique ID provided. If the specified Email does not exist, the response will be a "bad request".
forcemanager_get_emails_schemaREADEmails schema via GET /emails/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Email object.
forcemanager_get_entityownersREADList Entity Owners via GET /entityOwners. Returns all Entity Owners available. Entity Owners are basically needed to associate more than one User to an Entity (e.g. the Opportunities with more than one sales rep).
forcemanager_get_entityowners_schemaREADEntity Owners schema via GET /entityOwners/schema. Returns properties object with the definition of each field in the Entity Owners table.
forcemanager_get_extrafields_by_resourceREADList Extra Fields by Resource via GET /extrafields/{resource}. Returns all Extra Fields available in the user's ForceManager implementation database, for a specific Entity. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `activities`, `calendar`, `contacts`, `opportunities`, `products`, `rates`, `salesorders`, `users` -- the one place the vendor writes 'The allowed values are'. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_extrafields_by_resource_schemaREADExtra Fields schema by Resource via GET /extrafields/{resource}/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for an Extra Field object. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `activities`, `calendar`, `contacts`, `opportunities`, `products`, `rates`, `salesorders`, `users`. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_extrafieldstabsREADList Tabs via GET /extrafieldsTabs. Returns all Tabs available. Tabs are needed for grouping together Extra Fields of each entity.
forcemanager_get_extrafieldstabs_by_idREADGet Tabs via GET /extrafieldsTabs/{tab_id}. This endpoint retrieves data of a specific Tab based on JSON input. The API returns a single Tab available, according to the unique ID provided. If the specified Tab does not exist, the response will be a "bad request".
forcemanager_get_forms_by_idREADGet Form via GET /forms/{form_id}. This endpoint retrieves data of a specific Form based on JSON input. The API returns a single Form available to the user, according to the unique ID provided. If the specified Form does not exist, the response will be a "bad request".
forcemanager_get_forms_by_id_stateREADGet Form State via GET /forms/{form_id}/state. This endpoint retrieves data of a specific Form State based on JSON input. The API returns a single Form State available to the user, according to the unique ID provided. If the specified Form State does not exist, the response will be a "bad request".
forcemanager_get_forms_by_id_templateREADGet Form Template via GET /forms/{form_id}/template. This endpoint retrieves data of a specific Form Template based on JSON input. The API returns a single Form Template available to the user, according to the unique ID provided. If the specified Form Template does not exist, the response will be a "bad request".
forcemanager_get_hooksREADList Webhooks via GET /hooks. Returns all Webhooks available in the user's ForceManager implementation database.
forcemanager_get_hooks_by_idREADGet Webhook via GET /hooks/{webhook_id}. This endpoint retrieves data of a specific Webhook based on JSON input. The API returns a single Webhook available, according to the unique ID provided. If the specified Webhook does not exist, the response will be a "bad request".
forcemanager_get_listREADList Lists via GET /list. Returns all Lists available in the user's ForceManager implementation database based on JSON input.
forcemanager_get_list_by_nameREADList Values via GET /list/{list_name}. Returns all Values for the Value List available in the user's ForceManager implementation database based on JSON input. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_list_by_name_by_idREADGet Value via GET /list/{list_name}/{value_id}. This endpoint retrieves data of a specific Value from a specific Value List based on JSON input. The API returns a single Value available to the user in the Value List, according to the unique ID provided. If the specified Value or Value List do not exist, the response will be a "bad request".
forcemanager_get_list_by_name_schemaREADValues List schema via GET /list/{list_name}/schema. The Value List API provides a simple interface to manage your extra or customised Value Lists. Value Lists are personalised and predetermined values that help you unify criteria when entering data into a field and help organise these elements. The Schema is metadata that tells you how the data is structured for this specific customised Value List. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_newsREADList News via GET /news. Returns all News available. News are basically messages that you can sent to the whole organization, to your team or to an User. These messages can be tracked in terms of the number of Users that had received, open or read it.
forcemanager_get_opportunitiesREADList Opportunities via GET /opportunities. Returns all Opportunities available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_opportunities_by_idREADGet Opportunity via GET /opportunities/{opportunity_id}. This endpoint retrieves data of a specific Opportunity based on JSON input. The API returns a single Opportunity available to the user, according to the unique ID provided. If the specified Opportunity does not exist, the response will be a "bad request".
forcemanager_get_opportunities_schemaREADOpportunities schema via GET /opportunities/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for an Opportunity object.
forcemanager_get_opportunitystatusesREADList Opportunity Statuses via GET /opportunityStatuses. Returns all Opportunity Statuses available in the user's ForceManager implementation database.
forcemanager_get_opportunitystatuses_by_idREADGet Opportunity Status via GET /opportunityStatuses/{opportunity_status_id}. This endpoint retrieves data of a specific Opportunity Status based on JSON input. The API returns a single Opportunity Status available to the user in the Value List, according to the unique ID provided. If the specified Opportunity Status does not exist, the response will be a "bad request".
forcemanager_get_opportunitystatuses_schemaREADOpportunity Statuses schema via GET /opportunityStatuses/schema. Returns properties object with the definition of each field in the Opportunity Status table.
forcemanager_get_opportunitytypesREADList Opportunity Types via GET /opportunityTypes. Returns all Opportunity Types available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_opportunitytypes_by_idREADGet Opportunity Types via GET /opportunityTypes/{opportunity_type_id}. This endpoint retrieves data of a specific Opportunity Type based on JSON input. The API returns a single Opportunity Type available to the user in the Value List, according to the unique ID provided. If the specified Opportunity Type does not exist, the response will be a "bad request".
forcemanager_get_opportunitytypes_schemaREADOpportunity Types schema via GET /opportunityTypes/schema. Returns properties object with the definition of each field in the Opportunity Types table.
forcemanager_get_ordertypesREADList Order Types via GET /orderTypes. Returns all Orders Types available.
forcemanager_get_ordertypes_by_idREADGet Order Types via GET /orderTypes/{order_type_id}. This endpoint retrieves data of a specific Order Types based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Order Types does not exist, the response will be a "bad request".
forcemanager_get_ordertypes_schemaREADOrder Types schema via GET /orderTypes/schema. The Schema is metadata that tells you how the data is structured for this specific Value list.
forcemanager_get_productcategoriesREADList Product Categories via GET /productCategories. Returns all Product Categories available. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_productcategories_by_idREADGet Product Category via GET /productCategories/{product_category_id}. This endpoint retrieves data of a specific Product Category based on JSON input. The API returns a single Product Category available to the user in the Value List, according to the unique ID provided. If the specified Category does not exist, the response will be a "bad request".
forcemanager_get_productcategories_schemaREADProduct Categories schema via GET /productCategories/schema. Returns properties object with the definition of each field in the Product Categories table. With the Product Category you can classify each Product.
forcemanager_get_productfamiliesREADList Product Families via GET /productFamilies. Returns all Product Families available. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_productfamilies_by_idREADGet Product Family via GET /productFamilies/{product_family_id}. This endpoint retrieves data of a specific Product Family based on JSON input. The API returns a single Product Family available to the user in the Value List, according to the unique ID provided. If the specified Family does not exist, the response will be a "bad request".
forcemanager_get_productfamilies_schemaREADProduct Families schema via GET /productFamilies/schema. Returns properties object with the definition of each field in the Product Families table. With the Product Family you can classify each Product.
forcemanager_get_productratesREADList Product Rates via GET /productRates. Returns all Product Rates available. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_productrates_by_idREADGet Product Rate via GET /productRates/{product_rate_id}. This endpoint retrieves data of a specific Product Rate based on JSON input. The API returns a single Product Rate available to the user in the Value List, according to the unique ID provided. If the specified Rate does not exist, the response will be a "bad request".
forcemanager_get_productrates_schemaREADProduct Rates schema via GET /productRates/schema. Returns properties object with the definition of each field in the Product Rates table. With the Product Rate you can associate a Rate to each Product.
forcemanager_get_productsREADList Products via GET /products. Returns all Products available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_products_by_idREADGet Product via GET /products/{product_id}. This endpoint retrieves data of a specific Product based on JSON input. The API returns a single Product available to the user, according to the unique Product ID provided. If the specified Product does not exist, the response will be a "bad request". `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_products_schemaREADProducts schema via GET /products/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for a Product object.
forcemanager_get_ratesREADList Rates via GET /rates. Returns all Rates available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_rates_by_idREADGet Rate via GET /rates/{rate_id}. This endpoint retrieves data of a specific Rate based on JSON input. The API returns a single Rate available to the user, according to the unique ID provided. If the specified Rate does not exist, the response will be a "bad request".
forcemanager_get_rates_schemaREADRates schema via GET /rates/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Rate object.
forcemanager_get_resource_documentsREADList Documents of a Resource via GET /{resource}/{resource_id}/documents. Returns all Documents associated to the specific Resource (accounts, opportunities, salesOrders, ...) available in the user's ForceManager implementation database based on JSON input. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `salesOrders`, and the vendor's list ends in an ellipsis, so it is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_resource_documents_foldersREADList Folders of a Resource via GET /{resource}/{resource_id}/documents/folders. Returns all Folders of a specific Entity available in the user's ForceManager implementation database. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `salesOrders`, and the vendor's list ends in an ellipsis, so it is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_resource_warningsREADList Warnings of a Resource via GET /{resource}/{resource_id}/warnings. Returns all Warnings associated to the specific Resource (accounts, opportunities, products, salesorders) available in the user's ForceManager implementation database. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `products`, `salesorders`. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_resourcesREADGet Resources via GET /resources. This endpoint retrieves all the methods available in the API on JSON input.
forcemanager_get_rolesREADList Roles via GET /roles. Returns all Roles available in the user's ForceManager account database based on JSON input. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation.
forcemanager_get_roles_by_idREADGet Role via GET /roles/{role_id}. This endpoint retrieves data of a specific Role based on JSON input. The API returns a single Role available to the user, according to the unique ID provided. If the specified Role does not exist, the response will be a "bad request".
forcemanager_get_roles_by_id_usersREADList Users in Role via GET /roles/{role_id}/users. Returns all Users assigned to the specific Role available in the user's ForceManager implementation database. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_roles_schemaREADRoles schema via GET /roles/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Roles object.
forcemanager_get_salesREADList Sales via GET /sales. Returns all Sales available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_sales_by_idREADGet Sale via GET /sales/{sale_id}. This endpoint retrieves data of a specific Sale based on JSON input. The API returns a single Sale available to the user, according to the unique ID provided. If the specified Sale does not exist, the response will be a "bad request".
forcemanager_get_sales_schemaREADSales schema via GET /sales/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Sales object. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_salesordersREADList Order Headers via GET /salesorders. Returns all Order Headers available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_salesorders_by_idREADGet Order Header via GET /salesorders/{order_id}. This endpoint retrieves data of a specific Order Header based on JSON input. The API returns a single Header available to the user, according to the unique ID provided. If the specified Order Header does not exist, the response will be a "bad request".
forcemanager_get_salesorders_schemaREADOrder Headers schema via GET /salesorders/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for an Order Header object.
forcemanager_get_salesorderslinesREADList Order Lines via GET /salesordersLines. Returns all Orders Lines available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_salesorderslines_by_idREADGet Order Line via GET /salesordersLines/{order_line_id}. This endpoint retrieves data of a specific Order Line based on JSON input. The API returns a single Line available to the user, according to the unique ID provided. If the specified Order Line does not exist, the response will be a "bad request".
forcemanager_get_salesorderslines_schemaREADOrder Lines schema via GET /salesordersLines/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for an Order Line object.
forcemanager_get_salesorderstatusesREADList Order Statuses via GET /salesorderStatuses. Returns all Orders Statuses available.
forcemanager_get_salesorderstatuses_by_idREADGet Order Status via GET /salesorderStatuses/{order_status_id}. This endpoint retrieves data of a specific Order Status based on JSON input. The API returns a single Status available to the user in the Value List, according to the unique ID provided. If the specified Order Status does not exist, the response will be a "bad request".
forcemanager_get_salesorderstatuses_schemaREADOrder Statuses schema via GET /salesorderStatuses/schema. The Schema is metadata that tells you how the data is structured for this specific Value list.
forcemanager_get_timezonesREADList TimeZones via GET /timezones. Returns all TimeZones available.
forcemanager_get_usersREADList Users via GET /users. Returns all Users available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_users_by_idREADGet User via GET /users/{user_id}. This endpoint retrieves data of a specific User based on JSON input. The API returns a single User available to the user, according to the unique ID provided. If the specified User does not exist, the response will be a "bad request".
forcemanager_get_users_by_id_hierarchyREADList User Hierarchy via GET /users/{user_id}/hierarchy. This endpoint retrieves the hierarchy of a User based on JSON input. Specifically, an array of JSON data is returned, that reports the id and the name of each user that are below the requested User, on a hierarchical perspective. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_users_by_id_rolesREADList Roles of User via GET /users/{user_id}/roles. Returns all the Roles assigned to the user in ForceManager account database based on JSON input. <br> An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_get_users_schemaREADUsers schema via GET /users/schema. The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a User object.
forcemanager_get_users_scoresREADList Users Scores via GET /users/scores. This endpoint retrieves the activity and sales Scores of the Users - which measured via the ForceActivity algorithm - based on JSON input. Specifically, an array of JSON data is returned.
forcemanager_get_usertypesREADList User Types via GET /userTypes. Returns all User Types available in the user's ForceManager implementation database. `count` is sent as the `Count` header and sets the page SIZE (default 50); this build ships no page selector, because the converted contract declares no query parameter on any operation. `extra_field_description` is sent as the `ExtraFieldDescription` header: 0 returns Extra Field values only, 1 their descriptions too.
forcemanager_get_usertypes_by_idREADGet User Type via GET /userTypes/{user_type_id}. This endpoint retrieves data of a specific User Type based on JSON input. The API returns a single User Type available to the user in the Value List, according to the unique ID provided. If the specified User Type does not exist, the response will be a "bad request".
forcemanager_get_usertypes_schemaREADUser Types schema via GET /userTypes/schema. Returns properties object with the definition of each field in the User Type table.
forcemanager_post_accountaddressesWRITECreate Account Address via POST /accountAddresses. This endpoint allows you to create an Account Address based on JSON input.
forcemanager_post_accountsWRITECreate Account via POST /accounts. This endpoint allows you to create a Account based on JSON input.
forcemanager_post_accountsegmentsWRITECreate Account Segment via POST /accountSegments. This endpoint allows you to create a Account Segment based on JSON input.
forcemanager_post_accountsrelatedWRITECreate Related Account via POST /accountsRelated. This endpoint allows you to create a Related Account based on JSON input.
forcemanager_post_accountsrelationsWRITECreate Related Account Type via POST /accountsRelations. This endpoint allows you to create a Related Account Type based on JSON input.
forcemanager_post_accountstatusesWRITECreate Account Status via POST /accountStatuses. This endpoint allows you to create a Account Status based on JSON input.
forcemanager_post_accounttypesWRITECreate Account Type via POST /accountTypes. This endpoint allows you to create a Account Type based on JSON input.
forcemanager_post_activitiesWRITECreate Activity via POST /activities. This endpoint allows you to create an Activity based on JSON input.
forcemanager_post_activitytypesWRITECreate Activity Type via POST /activityTypes. This endpoint allows you to create an Activity Type based on JSON input.
forcemanager_post_calendarWRITECreate Calendar via POST /calendar. This endpoint allows you to create a Event/Task based on JSON input.
forcemanager_post_callsWRITECreate Call by User ID via POST /calls. This endpoint allows you to create a Call based on JSON input, providing the ForceManager User ID to whom the Call has to be associated.
forcemanager_post_calls_identifyWRITECreate Call by User Phone Number via POST /calls/identify. This endpoint allows you to create a Call based on JSON input, providing as an identifier of the ForceManager User its email instead of the ID. This endpoint is useful in the case in which the external system (e.g. a PBX) is not aware of the ForceManager User ID but it has the reference of all the Users' phone numbers.
forcemanager_post_campaignquestionsWRITECreate Campaign Question via POST /campaignQuestions. This endpoint allows you to create a Campaign Question based on JSON input.
forcemanager_post_campaignquestions_by_id_answersWRITECreate Question Answer via POST /campaignQuestions/{question_id}/answers. This endpoint allows you to create a Campaign Question Answer based on JSON input. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_campaignquestions_by_id_valuesWRITECreate Question Value via POST /campaignQuestions/{question_id}/values. This endpoint allows you to create a Campaign Question Value based on JSON input. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_campaignsWRITECreate Campaign via POST /campaigns. This endpoint allows you to create a Campaign based on JSON input.
forcemanager_post_campaigns_by_id_entities_by_entity_idWRITECreate Campaign Account via POST /campaigns/{campaign_id}/entities/{entity_id}. Links an Account to this Campaign, creating the Campaign Account record. If the specified Campaign or Account does not exist, the response is a bad request.
forcemanager_post_contactsWRITECreate Contact via POST /contacts. This endpoint allows you to create a Contact based on JSON input.
forcemanager_post_contacttypesWRITECreate Contact Type via POST /contactTypes. This endpoint allows you to create a Contact Type based on JSON input.
forcemanager_post_documentsWRITEAdd Document via POST /documents. This endpoint allows you to upload a Document based on JSON input. FIRST STEP ONLY: ForceManager answers with a `locator` URL the file must then be PUT to. This integration ships no binary channel, so it registers the document and returns that URL; moving the bytes is the caller's.
forcemanager_post_documents_foldersWRITECreate Folder via POST /documents/folders. This endpoint allows you to create a Folder based on JSON input.
forcemanager_post_emailsWRITECreate Email via POST /emails. This endpoint allows you to create an Email based on JSON input.
forcemanager_post_extrafields_by_resourceWRITECreate Extra Field for Resource via POST /extrafields/{resource}. This endpoint allows you to create an Extra Field for a specific entity. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `activities`, `calendar`, `contacts`, `opportunities`, `products`, `rates`, `salesorders`, `users` -- the one place the vendor writes 'The allowed values are'. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_extrafieldstabsWRITECreate Tabs via POST /extrafieldsTabs. This endpoint allows you to create a Tab based on JSON input.
forcemanager_post_hooksWRITECreate Webhook via POST /hooks. This endpoint allows you to create an Webhook based on JSON input.
forcemanager_post_listWRITECreate List via POST /list. This endpoint allows you to create a List based on JSON input.
forcemanager_post_list_by_nameWRITECreate Value via POST /list/{list_name}. This endpoint allows you to create a single Value or a complete Value List based on JSON input. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_opportunitiesWRITECreate Opportunity via POST /opportunities. This endpoint allows you to create a Opportunity based on JSON input.
forcemanager_post_opportunitystatusesWRITECreate Opportunity Status via POST /opportunityStatuses. This endpoint allows you to create a Opportunity Status based on JSON input.
forcemanager_post_opportunitytypesWRITECreate Opportunity Type via POST /opportunityTypes. This endpoint allows you to create a Opportunity Status based on JSON input.
forcemanager_post_ordertypesWRITECreate Order Types via POST /orderTypes. This endpoint allows you to create an Order Types based on JSON input.
forcemanager_post_productcategoriesWRITECreate Product Category via POST /productCategories. This endpoint allows you to create a Product Category based on JSON input.
forcemanager_post_productfamiliesWRITECreate Product Family via POST /productFamilies. This endpoint allows you to create a Product Family based on JSON input.
forcemanager_post_productratesWRITECreate Product Rate via POST /productRates. This endpoint allows you to create a Product Rate based on JSON input.
forcemanager_post_productsWRITECreate Product via POST /products. This endpoint allows you to create a Product based on JSON input.
forcemanager_post_products_bulkWRITEBulk Create Products via POST /products/bulk. This endpoint allows you to create Multiple Products (100 entities for request) based on JSON input.
forcemanager_post_products_by_id_documentsWRITEAdd Picture via POST /products/{product_id}/documents. This endpoint allows you to upload a Picture based on JSON input. FIRST STEP ONLY: ForceManager answers with a `locator` URL the file must then be PUT to. This integration ships no binary channel, so it registers the document and returns that URL; moving the bytes is the caller's. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_ratesWRITECreate Rate via POST /rates. This endpoint allows you to create a Rate based on JSON input.
forcemanager_post_resource_bulkWRITEBulk Create Resources via POST /{resource}/bulk. This endpoint allows you to create multiple Resources (200 entities for request) based on JSON input. `resource` is the entity name in the first path segment; the vendor documents Accounts, Contacts, Opportunities, Orders and Value Lists are the examples the vendor gives ('e.g.'), so the list is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_resource_documentsWRITEAdd Document to a Resource via POST /{resource}/{resource_id}/documents. This endpoint allows you to upload a Document linking it to a Resource (accounts, opportunities, salesOrders) based on JSON input. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `salesOrders`, and the vendor's list ends in an ellipsis, so it is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. FIRST STEP ONLY: ForceManager answers with a `locator` URL the file must then be PUT to. This integration ships no binary channel, so it registers the document and returns that URL; moving the bytes is the caller's. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_resource_documents_foldersWRITECreate Folder for a Resource via POST /{resource}/{resource_id}/documents/folders. This endpoint allows you to create a Folder for a specific Entity based on JSON input. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `salesOrders`, and the vendor's list ends in an ellipsis, so it is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_resource_warningsWRITECreate Warning for a Resource Copy via POST /{resource}/{resource_id}/warnings. This endpoint allows you to create a Warning in the specific Resource (accounts, opportunities, products, salesorders) based on JSON input. `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `products`, `salesorders`. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_post_salesWRITECreate Sale via POST /sales. This endpoint allows you to create a Sales based on JSON input.
forcemanager_post_salesordersWRITECreate Order Header via POST /salesorders. This endpoint allows you to create am Order Header based on JSON input.
forcemanager_post_salesorderslinesWRITECreate Order Line via POST /salesOrdersLines. This endpoint allows you to create Orders Lines based on JSON input.
forcemanager_post_salesorderstatusesWRITECreate Order Status via POST /salesorderStatuses. This endpoint allows you to create an Order Status based on JSON input.
forcemanager_post_usersWRITECreate User via POST /users. This endpoint allows you to create a User based on JSON input. `password` in the body is the NEW ForceManager user's own sign-in password, not this connection's credential.
forcemanager_post_usertypesWRITECreate User Type via POST /userTypes. This endpoint allows you to create a User Type based on JSON input.
forcemanager_put_accountaddresses_by_idWRITEUpdate Account Address via PUT /accountAddresses/{account_address_id}. This endpoint allows you to update a specific Account Address. If the specified Address does not exist, the response will be a "bad request".
forcemanager_put_accounts_by_idWRITEUpdate Account via PUT /accounts/{account_id}. This endpoint allows you to update a specific Account. If the specified Account does not exist, the response will be a "bad request".
forcemanager_put_accountsegments_by_idWRITEUpdate Account Segment via PUT /accountSegments/{account_segment_id}. This endpoint allows you to update a specific Account Segment. If the specified Account Segment does not exist, the response will be a "bad request".
forcemanager_put_accountsrelated_by_idWRITEUpdate Related Account via PUT /accountsRelated/{related_account_id}. The endpoint allows you to update a specific Related Account information from the user's ForceManager implementation database. If the specified Related Account does not exist, the response will be a "bad request".
forcemanager_put_accountsrelations_by_idWRITEUpdate Related Account Type via PUT /accountsRelations/{related_account_type_id}. This endpoint allows you to update a specific Related Account Type. If the specified Type does not exist, the response will be a "bad request".
forcemanager_put_accountstatuses_by_idWRITEUpdate Account Status via PUT /accountStatuses/{account_status_id}. This endpoint allows you to update a specific Account Status. If the specified Account Status does not exist, the response will be a "bad request".
forcemanager_put_activities_by_idWRITEUpdate Activity via PUT /activities/{activity_id}. This endpoint allows you to update a specific Activity. If the specified Activity does not exist, the response will be a "bad request".
forcemanager_put_activity_pointsWRITEUpdate Activity Points via PUT /activity/points. This endpoint allows you to update one or more Activity Points.
forcemanager_put_activitytypes_by_idWRITEUpdate Activity Type via PUT /activityTypes/{activity_type_id}. This endpoint allows you to update a specific Activity Type. If the specified Type does not exist, the response will be a "bad request".
forcemanager_put_calendar_by_idWRITEUpdate Calendar via PUT /calendar/{calendar_entry_id}. The endpoint allows you to update specific information of a calendar Event or Task from the user's ForceManager implementation database. If the specified Event or Task does not exist, the response will be a "bad request".
forcemanager_put_calls_by_idWRITEUpdate Call via PUT /calls/{call_id}. This endpoint allows you to update specific information of a Call. If the specified Call does not exist, the response will be a "bad request".
forcemanager_put_campaignquestions_by_idWRITEUpdate Campaign Question via PUT /campaignQuestions/{question_id}. This endpoint allows you to update a specific Campaign Question. If the specified Campaign Question does not exist, the response will be a "bad request".
forcemanager_put_campaignquestions_by_id_answers_by_idWRITEUpdate Question Answer via PUT /campaignQuestions/{question_id}/answers/{answer_id}. This endpoint allows you to update a specific Campaign Question Answer. If the specified Campaign Question Answer does not exist, the response will be a "bad request".
forcemanager_put_campaignquestions_by_id_values_by_idWRITEUpdate Question Value via PUT /campaignQuestions/{question_id}/values/{value_id}. This endpoint allows you to update a specific Campaign Question Value. If the specified Campaign Question Value does not exist, the response will be a "bad request".
forcemanager_put_campaigns_by_idWRITEUpdate Campaign via PUT /campaigns/{campaign_id}. This endpoint allows you to update a specific Campaign. If the specified Campaign does not exist, the response will be a "bad request".
forcemanager_put_campaigns_by_id_entities_by_entity_idWRITEUpdate Campaign Account via PUT /campaigns/{campaign_id}/entities/{entity_id}. This endpoint allows you to update a specific Campaign Account. If the specified Campaign Account does not exist, the response will be a "bad request".
forcemanager_put_contacts_by_idWRITEUpdate Contact via PUT /contacts/{contact_id}. This endpoint allows you to update a specific Contact. If the specified Contact does not exist, the response will be a "bad request".
forcemanager_put_contacttypes_by_idWRITEUpdate Contact Type via PUT /contactTypes/{contact_type_id}. This endpoint allows you to update a specific Contact Type. If the specified Contact Type does not exist, the response will be a "bad request".
forcemanager_put_extrafieldstabs_by_idWRITEUpdate Tabs via PUT /extrafieldsTabs/{tab_id}. This endpoint allows you to update a specific Tab's information. If the specified Tab does not exist, the response will be a "bad request".
forcemanager_put_hooks_by_idWRITEUpdate Webhook via PUT /hooks/{webhook_id}. This endpoint allows you to update a specific Webhook's information. If the specified Webhook does not exist, the response will be a "bad request".
forcemanager_put_list_accounttypes_by_idWRITEUpdate Account Type via PUT /list/accountTypes/{account_type_id}. This endpoint allows you to update a specific Account Type. If the specified Account Type does not exist, the response will be a "bad request".
forcemanager_put_list_by_nameWRITEUpdate List via PUT /list/{list_name}. This endpoint allows you to update a specific List's information. If the specified List does not exist, the response will be a "bad request".
forcemanager_put_list_by_name_by_idWRITEUpdate Value via PUT /list/{list_name}/{value_id}. This endpoint allows you to update a specific Value List's information. If the specified Value does not exist, the response will be a "bad request".
forcemanager_put_opportunities_by_idWRITEUpdate Opportunity via PUT /opportunities/{opportunity_id}. This endpoint allows you to update a specific Opportunity. If the specified Opportunity does not exist, the response will be a "bad request".
forcemanager_put_opportunitystatuses_by_idWRITEUpdate Opportunity Status via PUT /opportunityStatuses/{opportunity_status_id}. This endpoint allows you to update a specific Opportunity Status. If the specified Opportunity Status does not exist, the response will be a "bad request".
forcemanager_put_opportunitytypes_by_idWRITEUpdate Opportunity Type via PUT /opportunityTypes/{opportunity_type_id}. This endpoint allows you to update a specific Opportunity Status. If the specified Opportunity Status does not exist, the response will be a "bad request".
forcemanager_put_ordertypes_by_idWRITEUpdate Order Types via PUT /orderTypes/{order_type_id}. This endpoint allows you to update a specific Order Types. If the specified Types does not exist, the response will be a "bad request".
forcemanager_put_productcategories_by_idWRITEUpdate Product Category via PUT /productCategories/{product_category_id}. This endpoint allows you to update a specific information of a Product Category. If the specified Type does not exist, the response will be a "bad request".
forcemanager_put_productfamilies_by_idWRITEUpdate Product Family via PUT /productFamilies/{product_family_id}. This endpoint allows you to update a specific information of a Product Family. If the specified Type does not exist, the response will be a "bad request".
forcemanager_put_productrates_by_idWRITEUpdate Product Rate via PUT /productRates/{product_rate_id}. This endpoint allows you to update a specific information of a Product Rate. If the specified Type does not exist, the response will be a "bad request".
forcemanager_put_products_bulkWRITEBulk Update Products via PUT /products/bulk. This endpoint allows you to update a Multiple Products (100 entities for request) information from the user's ForceManager implementation database. In order to update Multiple Products, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
forcemanager_put_products_by_idWRITEUpdate Product via PUT /products/{product_id}. This endpoint allows you to update specific information of a Product from the user's ForceManager implementation database. If the specified Product does not exist, the response will be a "bad request".
forcemanager_put_rates_by_idWRITEUpdate Rate via PUT /rates/{rate_id}. This endpoint allows you to update specific information of a Rate. If the specified Rate does not exist, the response will be a "bad request".
forcemanager_put_resource_bulkWRITEBulk Update Resources via PUT /{resource}/bulk. This endpoint allows you to update a multiple Resources (200 entities for request) information from the user's ForceManager implementation database. In order to update multiple Resources, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes. `resource` is the entity name in the first path segment; the vendor documents Accounts, Contacts, Opportunities, Orders and Value Lists are the examples the vendor gives ('e.g.'), so the list is not exhaustive. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_put_resource_warnings_by_idWRITEUpdate Warning of a Resource via PUT /{resource}/{resource_id}/warnings/{warning_id}. This endpoint allows you to update a Warning in the specific Resource (accounts, opportunities, products, salesorders) based on JSON input. <br> `resource` is the entity name in the first path segment; the vendor documents `accounts`, `opportunities`, `products`, `salesorders`. That is prose, not a schema -- its capitalisation differs between the vendor's own articles -- so the value is passed through unchanged. An id that does not exist answers 400, not 404 (the vendor's own wording), so read the error body rather than the status.
forcemanager_put_sales_by_idWRITEUpdate Sale via PUT /sales/{sale_id}. The endpoint allows you to update a specific Sale information from the user's ForceManager implementation database. If the specified Contact does not exist, the response will be a "bad request".
forcemanager_put_salesorders_by_idWRITEUpdate Order Header via PUT /salesorders/{order_id}. This endpoint allows you to update a specific Order Header. If the specified Header does not exist, the response will be a "bad request".
forcemanager_put_salesorderslines_by_idWRITEUpdate Order Line via PUT /salesordersLines/{order_line_id}. This endpoint allows you to update a specific Order Line. If the specified Line does not exist, the response will be a "bad request".
forcemanager_put_salesorderstatuses_by_idWRITEUpdate Order Status via PUT /salesorderStatuses/{order_status_id}. This endpoint allows you to update a specific Order Status. If the specified Status does not exist, the response will be a "bad request".
forcemanager_put_users_by_idWRITEUpdate User via PUT /users/{user_id}. This endpoint allows you to update a specific User. If the specified User does not exist, the response will be a "bad request".
forcemanager_put_users_by_id_rolesWRITEAdd Roles in User via PUT /users/{user_id}/roles. This endpoint allows you to update a specific User's Roles information from the user's ForceManager account database. If the specified User does not exist, the response will be a "bad request". In order to update the User's Roles, you just have to specify the Role you want to add at.
forcemanager_put_usertypes_by_idWRITEUpdate User Type via PUT /userTypes/{user_type_id}. This endpoint allows you to update a specific User Type. If the specified User Type does not exist, the response will be a "bad request".
Often connected alongside
Put ForceManager behind one governed endpoint.
Same permissions, same audit trail, whatever else you connect next.