Skip to navigation
API ReferenceIntegrations

CreateIntegrationAuthorization

CreateIntegrationAuthorization returns the CRM's consent page to send the user to. The CRM returns them to Edulead with a code and a state for ConnectIntegration, within an hour.

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

integration_idenumRequired

The CRM, hubspot or salesforce.

Allowed values:

Headers

Edulead-TeamstringRequired

Query parameters

request_idstringOptional1-64 characters

Caller-chosen idempotency key. The same key from the same caller within 24 hours returns the original result instead of acting again.

Request

This endpoint expects an object.
authorization_urlstringOptional<=8192 characters
The CRM's consent page, carrying the state ConnectIntegration checks.
expire_timedatetimeOptional
When the state stops being accepted.

Response

Success
integration_authorizationobjectOptional

IntegrationAuthorization is the start of a connection: the CRM’s consent page to send the user to. The service sets both fields.