Skip to navigation
API ReferenceIntegrations

UpdateIntegration

UpdateIntegration changes the fields update_mask names: app_installed (Salesforce only), contact_field_mappings, institution_field_mappings. A mapping list replaces the stored one; editing mappings needs the CRM connected and the crm-field-mappings:edit permission, app_installed the crm-connection:manage permission.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

idenumRequired
Identifier of the resource, assigned by Edulead and opaque to callers.
Allowed values:

Headers

Edulead-TeamstringRequired

Query parameters

update_maskstringOptional
Which fields of the resource to change. Fields not listed keep their values.

Request

This endpoint expects an object.
idstringOptional<=20 characters
Identifier of the resource, assigned by Edulead and opaque to callers.
connectedbooleanOptional
Whether the team has connected the CRM.
account_idstringOptional<=255 characters

The connected account: the HubSpot portal id, the Salesforce organization id.

instance_urlstringOptional<=1024 characters

The Salesforce organization’s base URL; empty for HubSpot.

scopeslist of stringsOptional
The OAuth scopes the CRM granted.
connect_timedatetimeOptional
When the CRM was connected.
app_installedbooleanOptional

Salesforce: whether the Edulead package is installed in the organization; always false for HubSpot.

contact_field_mappingslist of objectsOptional

How Edulead’s contact fields map to the CRM’s contact fields. contact_field_mappings.unique // each edulead_field may be mapped once

institution_field_mappingslist of objectsOptional

How Edulead’s institution fields map to the CRM’s company (HubSpot) or account (Salesforce) fields. institution_field_mappings.unique // each edulead_field may be mapped once

field_mappings_configuredbooleanOptional
Whether every field an export to the CRM requires is mapped.
missing_required_fieldslist of objectsOptional
The required fields that are not mapped yet, contacts first.
update_timedatetimeOptional
When any field last changed.

Response

Success
integrationobjectOptional

Integration is one CRM and the team’s connection to it; id is hubspot or salesforce. Only app_installed and the two mapping lists can change; the service sets the others.