Accounts

Get active all accounts

In InboxComponents, an Account represents a specific communication channel or service that a client integrates into their environment. Currently, we support integration with WhatsApp accounts, with plans to include LinkedIn, Telegram, Instagram, and email (Gmail, Outlook) in the near future.

🔑 Dashboard owners: Adding accounts via the dashboard

Dashboard owners can seamlessly add and manage accounts through the InboxComponents Dashboard.

Steps to Add an Account:

Navigate to the Dashboard: Log in to your InboxComponents dashboard.
Access the Accounts Section: Click on the Accounts tab in the main menu.
Add a New Account: Select Add Account and choose the desired communication platform (e.g., WhatsApp).
Configure Account Details: Enter the necessary information, such as account name and authentication credentials.
Save and Authenticate: Click Save to authenticate and establish the connection.

By following these steps, dashboard owners can centrally manage communication accounts, ensuring streamlined operations and oversight.

You can manage your accounts here: https://app.inboxcomponents.com/portal/account

🔒 Customers: Adding accounts via the embedded inbox

Customers can integrate their own communication accounts directly within the embedded inbox of the host application. This approach enhances security by allowing customers to manage their credentials without exposing them to external parties.

Benefits of Customer-Managed Integration:

Enhanced Security: Customers retain control over their authentication credentials, reducing the risk of data exposure.
Personalized Experience: Enables customization of communication channels to align with individual preferences.
Operational Efficiency: Streamlines the integration process by allowing direct account management within the application.

Steps for Customers to Add an Account:

Access the Embedded Inbox: Log in to the host application and navigate to the embedded inbox feature.
Initiate Account Integration: Select the option to add a new account and choose the desired platform (e.g., WhatsApp).
Authenticate the Account: Follow the on-screen instructions to enter authentication details and grant necessary permissions.
Confirm Integration: Upon successful authentication, the account will be linked and ready for use within the embedded inbox.

This method empowers customers to securely connect their communication channels, fostering trust and autonomy in managing their interactions.

Future integrations

We are actively working to expand our supported integrations to include:

LinkedIn: Facilitating professional networking and communication.
Telegram: Enabling messaging through the popular Telegram platform.
InstaGram: Allowing interactions via Instagram's messaging features.
Email: Integrating traditional email communication channels.

API Documentation

List connected accounts

get

Returns all connected accounts across all integrations. These accounts are used by the inbox to fetch and send messages.

Authorizations

AuthorizationstringRequired

JWT token authentication (login via /authentication/login_check)

Query parameters

pageintegerOptional

The collection page number

Default: 1

Responses

200

Account collection

403

Forbidden

get

/api/accounts

GET /api/accounts HTTP/1.1
Host: app.inboxcomponents.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "username": "Michael Scott",
      "description": "Regional Manager at Dunder Mifflin",
      "avatarUrl": "https://example.com/avatars/michael_scott.png",
      "accountType": "whatsapp",
      "integrationLogo": "whatsapp",
      "integration": "\"/api/integrations/whatsapp",
      "isAuthorized": true,
      "sharePastHistory": true,
      "reconnectUrl": null,
      "createdAt": "2025-12-06T04:35:33.192Z",
      "disconnectedAt": null,
      "historySyncUntil": null,
      "clientId": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0",
      "id": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0"
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}

Get connected account

get

Returns details of a specific connected account (e.g., WhatsApp number or LinkedIn login).

Authorizations

AuthorizationstringRequired

JWT token authentication (login via /authentication/login_check)

Path parameters

idstringRequired

Account identifier

Responses

200

Account resource

403

Forbidden

404

Not found

get

/api/accounts/{id}

GET /api/accounts/{id} HTTP/1.1
Host: app.inboxcomponents.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "username": "Michael Scott",
  "description": "Regional Manager at Dunder Mifflin",
  "avatarUrl": "https://example.com/avatars/michael_scott.png",
  "accountType": "whatsapp",
  "integrationLogo": "whatsapp",
  "integration": "\"/api/integrations/whatsapp",
  "isAuthorized": true,
  "sharePastHistory": true,
  "reconnectUrl": null,
  "createdAt": "2025-12-06T04:35:33.192Z",
  "disconnectedAt": null,
  "historySyncUntil": null,
  "clientId": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0",
  "id": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0"
}

Connect new account

post

Connects a new account (e.g., WhatsApp, LinkedIn, etc.) to the inbox. The payload includes authentication and setup details.

Authorizations

AuthorizationstringRequired

JWT token authentication (login via /authentication/login_check)

Body

Represents a connected account for an integration, such as a specific WhatsApp number, LinkedIn profile, or Instagram account. These are used by the inbox to send and receive messages.

integrationstring | nullRequiredExample: /integrations/{id}

historySyncUntilstring | nullOptional

Responses

201

Account resource created

400

Invalid input

403

Forbidden

422

An error occurred

post

/api/accounts

POST /api/accounts HTTP/1.1
Host: app.inboxcomponents.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/ld+json
Accept: */*
Content-Length: 60

{
  "integration": "/integrations/{id}",
  "historySyncUntil": null
}

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "username": "Michael Scott",
  "description": "Regional Manager at Dunder Mifflin",
  "avatarUrl": "https://example.com/avatars/michael_scott.png",
  "accountType": "whatsapp",
  "integrationLogo": "whatsapp",
  "integration": "\"/api/integrations/whatsapp",
  "isAuthorized": true,
  "sharePastHistory": true,
  "reconnectUrl": null,
  "createdAt": "2025-12-06T04:35:33.192Z",
  "disconnectedAt": null,
  "historySyncUntil": null,
  "clientId": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0",
  "id": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0"
}

Disconnect account

delete

Removes a connected account from the inbox system.

Authorizations

AuthorizationstringRequired

JWT token authentication (login via /authentication/login_check)

Path parameters

idstringRequired

Account identifier

Responses

204

Account resource deleted

403

Forbidden

404

Not found

delete

/api/accounts/{id}

DELETE /api/accounts/{id} HTTP/1.1
Host: app.inboxcomponents.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update connected account

put

Updates configuration details for a connected account, such as access settings or metadata.

Authorizations

AuthorizationstringRequired

JWT token authentication (login via /authentication/login_check)

Path parameters

idstringRequired

Account identifier

Body

Represents a connected account for an integration, such as a specific WhatsApp number, LinkedIn profile, or Instagram account. These are used by the inbox to send and receive messages.

@contextone ofRead-onlyOptional

stringOptional

@idstringRead-onlyOptional

@typestringRead-onlyOptional

usernamestring | nullOptionalExample: Michael Scott

descriptionstring | nullOptionalExample: Regional Manager at Dunder Mifflin

avatarUrlstring | nullOptionalExample: https://example.com/avatars/michael_scott.png

accountTypestring | nullOptionalExample: whatsapp

integrationLogostring | nullOptionalExample: whatsapp

integrationstring · iri-referenceOptionalExample: "/api/integrations/whatsapp

isAuthorizedbooleanOptional

sharePastHistorybooleanOptional

reconnectUrlstring | nullOptional

createdAtstring · date-timeOptional

disconnectedAtstring | nullOptional

historySyncUntilstring | nullOptional

clientIdstring | nullOptionalExample: e6a2e786-2ce0-444a-b08c-ca21ed816bf0

idstring | nullOptionalExample: e6a2e786-2ce0-444a-b08c-ca21ed816bf0

Responses

200

Account resource updated

400

Invalid input

403

Forbidden

404

Not found

422

An error occurred

put

/api/accounts/{id}

PUT /api/accounts/{id} HTTP/1.1
Host: app.inboxcomponents.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/ld+json
Accept: */*
Content-Length: 481

{
  "username": "Michael Scott",
  "description": "Regional Manager at Dunder Mifflin",
  "avatarUrl": "https://example.com/avatars/michael_scott.png",
  "accountType": "whatsapp",
  "integrationLogo": "whatsapp",
  "integration": "\"/api/integrations/whatsapp",
  "isAuthorized": true,
  "sharePastHistory": true,
  "reconnectUrl": null,
  "createdAt": "2025-12-06T04:35:33.192Z",
  "disconnectedAt": null,
  "historySyncUntil": null,
  "clientId": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0",
  "id": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0"
}

{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "username": "Michael Scott",
  "description": "Regional Manager at Dunder Mifflin",
  "avatarUrl": "https://example.com/avatars/michael_scott.png",
  "accountType": "whatsapp",
  "integrationLogo": "whatsapp",
  "integration": "\"/api/integrations/whatsapp",
  "isAuthorized": true,
  "sharePastHistory": true,
  "reconnectUrl": null,
  "createdAt": "2025-12-06T04:35:33.192Z",
  "disconnectedAt": null,
  "historySyncUntil": null,
  "clientId": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0",
  "id": "e6a2e786-2ce0-444a-b08c-ca21ed816bf0"
}

PreviousSending NextClients

Last updated 8 months ago

Was this helpful?