Skip to content

Connect Sugarcrm

POST
/integrations/sugarcrm/connect

Connect SugarCRM. REACHES YOUR SUGARCRM to authenticate first.

409 when a SugarCRM connection already exists - rotate its credentials with /sugarcrm/reconnect instead. 400 for an instance URL that does not resolve to a public host, 401 when SugarCRM rejects the credentials.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

SugarCRM credentials for the password-grant connection.

WRITE-ONLY: the username, password and client secret are stored encrypted and no operation returns them.

object
client_id

OAuth client id configured in SugarCRM.

string
default: sugar
client_secret

OAuth client secret, if your client id has one.

string
""
instance_url
required

Your SugarCRM instance, e.g. https://acme.sugarondemand.com.

string
password
required
string
username
required
string

Responses

201

Successful Response

object
data
required

An open envelope for one result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string