OAuth 2.0 Endpoints — Authorize and Get Access Token

EffiLink supports OAuth 2.0 Authorization Code flow as an alternative to ApiKey authentication. Use the two endpoints below to obtain an access token that can be passed via the OAuth header on any API request.

Authorization URL

Redirects the user to the EffiLink authorization consent page. After the user approves access, EffiLink redirects back to your redirect_uri with a short-lived authorization code.

Query Parameters

string

required

The OAuth application ID generated in the EffiLink platform.

string

required

Must be code. This is the only supported value.

string

required

URL-encoded callback URL where EffiLink will send the authorization code after the user approves. Must exactly match the redirect URI registered for your OAuth application.

string

required

Must be All. This is the only supported scope value.

Response

This endpoint does not return JSON. It issues an HTTP redirect to the EffiLink authorization consent page. After the user approves the authorization request, EffiLink redirects the browser to:

{redirect_uri}?code=AUTHORIZATION_CODE

The authorization code is valid for 5 minutes and can only be used once. Exchange it for an access token immediately using the Get Access Token endpoint.

curl --request GET \
  --url 'https://api.effilink.co/v5/auth/oauth/authorize?client_id=1751651162214168&response_type=code&redirect_uri=https%3A%2F%2Fyourapp.com%2Fcallback&scope=All'

Get Access Token

Exchanges a valid authorization code for an access token. The token is used in the OAuth header on subsequent API requests.

Query Parameters

string

required

Must be authorization_code. This is the only supported value.

string

required

The OAuth application ID generated in the EffiLink platform.

string

required

The OAuth application secret generated in the EffiLink platform. Keep this value confidential.

string

required

The authorization code received in the redirect_uri callback from the Authorization URL step.

Response

integer

200 on success.

string

null on success; an error description on failure.

string

The access token to include in the OAuth header on API requests. Maximum length is 512 bytes.

integer

Remaining validity period of the token in seconds. -1 indicates the token is permanent and does not expire.A new token can be generated when fewer than 5 minutes remain (expiresIn < 300). During the brief transition window, both the old and new tokens are simultaneously valid, preventing request interruption.

Only one active token per API key is allowed during its validity period.

curl --request GET \
  --url 'https://api.effilink.co/v5/auth/oauth/token?grant_type=authorization_code&client_id=1751651162214168&client_secret=YOUR_CLIENT_SECRET&code=AUTHORIZATION_CODE'

Response

{
  "code": 200,
  "message": null,
  "accessToken": "5cb089d6eafd49caa68c41b9be9af6f6",
  "expiresIn": -1
}

Using the Access Token

Pass the access token in the OAuth header on any EffiLink API request:

curl --request POST \
  --url https://api.effilink.co/v5/transactional/mail/sends_customised \
  --header 'Content-Type: application/json' \
  --header 'OAuth: 5cb089d6eafd49caa68c41b9be9af6f6' \
  --data '{...}'

If you prefer not to implement the OAuth flow, you can use your ApiKey header directly. Both authentication methods are accepted on all EffiLink API endpoints.

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

OAuth 2.0 Endpoints — Authorize and Get Access Token

Authorization URL

Query Parameters

Response

Get Access Token

Query Parameters

Response

Using the Access Token

​Authorization URL

​Query Parameters

​Response

​Get Access Token

​Query Parameters

​Response

​Using the Access Token

Authorization URL

Query Parameters

Response

Get Access Token

Query Parameters

Response

Using the Access Token