Create an onboarding session

Trigger AI agent onboarding for the specified entity and channel. Creates the necessary entities and schedules async jobs for data preparation.

post

Authorizations

D360-API-KEY

D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Query parameters

channelstring · enumRequired

The channel to onboard the AI agent for

Possible values:

Header parameters

X-API-Versionstring · enumOptional

Meta Business Agent API version

Possible values:

Responses

201

Onboarding triggered successfully

application/json

Result of triggering AI agent onboarding

agent_idstringOptionalExample: 1234567890

400

Bad request

application/json

401

Unauthorized

application/json

429

Too many requests

application/json

500

Server error

application/json

post/agent_onboarding

HTTPcURLJavaScriptPython

POST /agent_onboarding?channel=email HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "agent_id": "1234567890"
}