See what the SugarCRM integration can do →
This article lists the SugarCRM REST API endpoints that the iPaaS.com integration calls. Use it as a reference for firewall allow-listing, API-scope review, and troubleshooting, and to check whether a SugarCRM API change affects the integration.
API Endpoints Intro
The integration uses the SugarCRM REST API over HTTPS. Every request is made against your own SugarCRM instance, so the base URL is your SugarCRM host plus the REST path and API version:
[Base URL] = https://<your-sugarcrm-host>/rest/<version>
For example, https://demo.sugarcrm.com/rest/v11_25. The same base URL is used for both test and production; the difference is the SugarCRM instance you point at. In the endpoint patterns below, [Base URL] stands for this value and {id} stands for a SugarCRM record id.
Table of Contents
Account Endpoints
Contact Endpoints
Web Logic Hook Endpoints
Authorization Endpoint
Account Endpoints
Get an Account (GET)
[Base URL]/Accounts/{id}
Retrieves a single Account by its id. Used during TO iPaaS.com transfers and Manual Sync to read the full Account record.
Create an Account (POST)
[Base URL]/Accounts
Creates a new Account from an iPaaS.com Customer.
Update an Account (PUT)
[Base URL]/Accounts/{id}
Updates an existing Account. The integration sends the full Account record.
Delete an Account (DELETE)
[Base URL]/Accounts/{id}
Deletes an Account.
Find an Account by email (POST)
[Base URL]/Accounts/filter
Searches for an Account whose email matches a supplied value. Used on the first FROM iPaaS.com transfer to link to an existing Account instead of creating a duplicate. The match value is sent in the request's filter body.
Link a Contact to an Account (POST)
[Base URL]/Accounts/{id}/link
Associates a Contact with an Account after the Contact is created, so the Account's primary contact is maintained.
Contact Endpoints
Find a Contact (POST)
[Base URL]/Contacts/filter
Searches for the Contact associated with an Account (or a specific Contact by id) so the correct primary contact is matched.
Create a Contact (POST)
[Base URL]/Contacts
Creates a Contact for an Account when contact name values are provided.
Update a Contact (PUT)
[Base URL]/Contacts/{id}
Updates an existing Contact.
Delete a Contact (DELETE)
[Base URL]/Contacts/{id}
Deletes a Contact — for example, when its parent Account is deleted.
Web Logic Hook Endpoints
SugarCRM refers to its webhooks as Web Logic Hooks. iPaaS.com manages these automatically when automatic transfers are enabled; the endpoints are listed here for reference.
List Web Logic Hooks (GET)
[Base URL]/WebLogicHooks?offset={offset}&max_num={max}
Lists the configured Web Logic Hooks, paged with offset and max_num.
Create a Web Logic Hook (POST)
[Base URL]/WebLogicHooks
Registers the Web Logic Hook that notifies iPaaS.com of Account changes.
Delete a Web Logic Hook (DELETE)
[Base URL]/WebLogicHooks/{id}
Removes a Web Logic Hook.
Authorization Endpoint
The integration authenticates with OAuth 2.0 against your SugarCRM instance's token endpoint.
Obtain a token (POST)
[Base URL]/oauth2/token
Exchanges the API user's username and password for an access token (grant_type=password). The integration requests this token when it first connects.
Refresh a token (POST)
[Base URL]/oauth2/token
Exchanges a refresh token for a new access token (grant_type=refresh_token). The integration refreshes the token automatically as it expires, so no re-entry of credentials is required.
Authentication
All Account, Contact, and Web Logic Hook requests are sent with the OAuth 2.0 access token obtained from the Authorization endpoint. iPaaS.com obtains and refreshes the token automatically using the API URL, username, and password saved on the subscription. See SugarCRM Connections and Settings for how those credentials are configured.
Related Documents