Skip to content

Deflection API V3 — Developer Guide


1. Overview

The Deflection API allows you to deflect customer calls to digital channels by providing options in IVR. This enables seamless redirection of customer interactions from voice to modern engagement channels such as WhatsApp Business, Apple Business Chat, or Sprinklr Live Chat.

This endpoint replaces the V2 path /api/v2/deflect with a simplified V3 resource:

OperationMethodPath
Deflect call to digital channelPOST/api/v3/deflect

2. Base URLs and environments

All API calls are sent to the production endpoint:

https://api3.sprinklr.com/{env}/api/v3

So the deflection resource in production is:

https://api3.sprinklr.com/{env}/api/v3/deflect

Replace {env} with your assigned environment identifier (prod0, prod2, prod11, etc.).


3. Authentication and common headers

All Deflection API calls are authenticated with OAuth 2.0. See API Overview for portal registration, API key and secret generation, and the Authorize flow.

HeaderValuePurposeRequired on
AuthorizationBearer {{accessToken}}Authenticates the user with the serverAll requests
Key{{apiKey}}Authenticates the application with the serverAll requests
Content-Typeapplication/jsonDeclares the request body media typeAll requests
Acceptapplication/jsonDeclares the acceptable response typeAll requests

4. Write operation

4.1 Deflect a call

POST /api/v3/deflect

Deflects a customer call to a specified digital channel.

Request parameters

ParameterRequired/OptionalDescriptionType
assetIdRequiredID of the asset to be sent.String
snIdRequiredSocial network ID of the profile for which deflection is being done.String
accountIdRequiredAccount ID to use for replying.String
deflectionTypeRequiredChannel being deflected to.String
createCaseOptionalWhether or not a new case needs to be created. Default: true.Boolean
caseNumberOptionalCase number to which the conversation needs to be linked.String
customPropertiesOptionalMap of case custom properties and values.Map<String, List>
messageCustomPropertiesOptionalMap of outbound message custom properties and values.Map<String, List>
commentOptionalAny comments to be included from previous cases/interactions.String
configIdOptionalID of configuration containing logic for case association.String
urlShortnerIdOptionalID of the URL shortener when sending a deflection link (used in SMS for Apple Business Chat or Live Chat).String
viaDeflectionTypeOptionalChannel used for deflection (e.g., SMS).String
viaAccountIdOptionalAccount ID of the via channel.String

Example — Request

curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/deflect' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {TOKEN}' \
--header 'api-key: {API KEY}' \
--header 'Accept: application/json' \
--data '{
  "assetId": "6a8e35a68efcd69ba4fdc844",
  "snId": "13183512964",
  "accountId": 66014972,
  "deflectionType": "WHATSAPP_BUSINESS"
}'

Example — Response

{
  "errors": []
}

4.2 Example — viaAccount Deflection

Deflecting to a social channel using another social channel, e.g., deflecting to Sprinklr Live Chat via SMS.

curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/deflect' \
--header 'Authorization: Bearer {Access Token}' \
--header 'api-key: {API KEY}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "assetId": "6a8e35a68efcd69ba4fdc844",
  "snId": "13183512964",
  "accountId": 100022,
  "deflectionType": "SPRINKLR_LIVE_CHAT",
  "viaDeflectionType": "SMS",
  "viaAccountId": 100122,
  "createCase": true
}'

5. Response format and parameters

The V3 envelope is consistent across endpoints:

{
  "errors": []
}

6. Response codes

HTTP CodeScenarioDescription
200 OKSuccessDeflection executed successfully
400 Bad RequestInvalid ParametersMissing or invalid request parameters
401 UnauthorizedAuthentication FailedInvalid or missing Authorization token
403 ForbiddenInsufficient PermissionsUser lacks permission to perform deflection
404 Not FoundResource MissingAsset or account not found
500 Internal Server ErrorServer ErrorUnexpected server‑side error occurred

7. Migration from V2 to V3

The Deflection API in V3 continues to provide the same functionality and request/response behavior as in V2.
The only change is the endpoint path, updated for consistency with other V3 APIs.

OperationV2 EndpointV3 EndpointKey Differences
Deflect call to digital channelPOST /api/v2/deflectPOST /api/v3/deflectPath updated from /api/v2 to /api/v3.
Deflect via another channelPOST /api/v2/deflectPOST /api/v3/deflectSame operation; only path changed.