Api referenceGeneratedIntegrations
Attach an integration to an agent
Attach one of your integrations to the agent. The agent can use it on its next call. Integrations already attached stay as they are.
POST/agents//integrations
Bearersession
Path parameters
agent_idrequiredBody
2 fields
·
Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).
The integration's id, from listIntegrations or a create response.
curl -X POST 'https://omnidim.io/api/v1/agents/{agent_id}/integrations' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "user_id": 1234 }'
Example response
synthetic
{ "success": false, "message": "string" }
BearerAuthheader
AuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
agent_id*integerThe ID of the agent.
application/jsonuser_id?ClientUserIdReseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.
integration_id*integerThe integration's id, from listIntegrations or a create response.
Response body
application/jsonThe integration was attached.
application/jsonsuccess?booleanmessage?string