MeetInboxXia API

https://send.meetinboxxia.com/api/reference
Admin
MeetInboxXia API provides programmatic access to manage user accounts, email campaigns, replies, and...
Tokens:9,205
Snippets:30
Trust Score:6
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /api/users

Source: https://send.meetinboxxia.com/api/reference/index

Retrieves the details of the authenticated user. Requires a valid authentication token in the request header.

```APIDOC
## GET /api/users

### Description
Retrieves the details of the authenticated user. The user must provide a valid authentication token in the request header to access this endpoint.

### Method
GET

### Endpoint
/api/users

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl https://send.meetinboxxia.com/api/users \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **data** (object) - User details, including id, name, email, team information, and profile photo details.

#### Response Example
```json
{
  "data": {
    "id": 1,
    "name": "John Doe",
    "email": "john@doe.com",
    "team": {
      "id": 1,
      "name": "John Doe's Team",
      "personal_team": true,
      "main": true,
      "parent_id": null,
      "total_monthly_email_verification_credits": 0,
      "remaining_monthly_email_verification_credits": 0,
      "remaining_email_verification_credits": 0,
      "total_email_verification_credits": 0,
      "sender_email_limit": 100000,
      "warmup_limit": 100000,
      "warmup_filter_phrase": null,
      "has_access_to_warmup": false,
      "has_access_to_healthcheck": false,
      "created_at": "2025-04-14T16:59:21.000000Z",
      "updated_at": "2025-05-18T12:53:32.000000Z"
    },
    "profile_photo_path": null,
    "profile_photo_url": "https://ui-avatars.com/api/?name=J&color=7F9CF5&background=EBF4FF",
    "created_at": "2025-04-14T16:59:21.000000Z",
    "updated_at": "2025-05-18T12:53:32.000000Z"
  }
}
```
```

--------------------------------

### GET /api/users

Source: https://send.meetinboxxia.com/api/reference/index

Retrieves account details for the authenticated user.

```APIDOC
## GET /api/users

### Description
Retrieves account details for the authenticated user.

### Method
GET

### Endpoint
/api/users

### Parameters

#### Query Parameters
(No query parameters documented)

#### Path Parameters
(No path parameters documented)

#### Request Body
(No request body documented)

### Request Example
```
GET /api/users
Host: send.meetinboxxia.com
Authorization: Bearer YOUR_API_TOKEN
```

### Response
#### Success Response (200)
(Response fields not explicitly documented in the provided text. Typically includes user profile information.)

#### Response Example
```json
{
  "example": "response body for /api/users"
}
```
```

--------------------------------

### Get Account Details using Curl

Source: https://send.meetinboxxia.com/api/reference/index

Retrieves the details of the authenticated user. Requires a valid Bearer token in the Authorization header. Returns user information in JSON format.

```shell
curl https://send.meetinboxxia.com/api/users \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### Workspaces v1.1 API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing workspace-related operations, including creation, updates, and deletion of workspaces.

```APIDOC
## Workspaces v1.1 Operations

### GET /api/workspaces/v1.1
**Description**: Retrieves a list of workspaces (v1.1).
**Method**: GET
**Endpoint**: /api/workspaces/v1.1

### POST /api/workspaces/v1.1
**Description**: Creates a new workspace (v1.1).
**Method**: POST
**Endpoint**: /api/workspaces/v1.1

### POST /api/workspaces/v1.1/users
**Description**: Adds a user to a workspace (v1.1).
**Method**: POST
**Endpoint**: /api/workspaces/v1.1/users

### POST /api/workspaces/v1.1/{team_id}/api-tokens
**Description**: Creates an API token for a workspace (v1.1).
**Method**: POST
**Endpoint**: /api/workspaces/v1.1/{team_id}/api-tokens

### POST /api/workspaces/v1.1/switch-workspace
**Description**: Switches the active workspace (v1.1).
**Method**: POST
**Endpoint**: /api/workspaces/v1.1/switch-workspace

### DELETE /api/workspaces/v1.1/{team_id}
**Description**: Deletes a workspace by its ID (v1.1).
**Method**: DELETE
**Endpoint**: /api/workspaces/v1.1/{team_id}

### PUT /api/workspaces/v1.1/{team_id}
**Description**: Updates a workspace by its ID (v1.1).
**Method**: PUT
**Endpoint**: /api/workspaces/v1.1/{team_id}

### GET /api/workspaces/v1.1/{team_id}
**Description**: Retrieves a specific workspace by its ID (v1.1).
**Method**: GET
**Endpoint**: /api/workspaces/v1.1/{team_id}

### POST /api/workspaces/v1.1/invite-members
**Description**: Invites members to a workspace (v1.1).
**Method**: POST
**Endpoint**: /api/workspaces/v1.1/invite-members

### POST /api/workspaces/v1.1/accept/{team_invitation_id}
**Description**: Accepts a workspace invitation (v1.1).
**Method**: POST
**Endpoint**: /api/workspaces/v1.1/accept/{team_invitation_id}

### DELETE /api/workspaces/v1.1/members/{user_id}
**Description**: Removes a member from a workspace (v1.1).
**Method**: DELETE
**Endpoint**: /api/workspaces/v1.1/members/{user_id}

### GET /api/workspaces/v1.1/master-inbox-settings
**Description**: Retrieves master inbox settings for a workspace (v1.1).
**Method**: GET
**Endpoint**: /api/workspaces/v1.1/master-inbox-settings

### PATCH /api/workspaces/v1.1/master-inbox-settings
**Description**: Updates master inbox settings for a workspace (v1.1).
**Method**: PATCH
**Endpoint**: /api/workspaces/v1.1/master-inbox-settings

### GET /api/workspaces/v1.1/stats
**Description**: Retrieves workspace statistics (v1.1).
**Method**: GET
**Endpoint**: /api/workspaces/v1.1/stats

### GET /api/workspaces/v1.1/line-area-chart-stats
**Description**: Retrieves line area chart statistics for a workspace (v1.1).
**Method**: GET
**Endpoint**: /api/workspaces/v1.1/line-area-chart-stats
```

--------------------------------

### Domain Blacklist API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing blacklisted domains, including retrieving, creating, bulk creating, and removing domains.

```APIDOC
## Domain Blacklist API

APIs for managing blacklisted domains. This includes retrieving, creating, bulk creating, and removing blacklisted domains.

### GET /api/blacklisted-domains

**Description**: Retrieves a list of blacklisted domains.

**Method**: GET

**Endpoint**: /api/blacklisted-domains

### POST /api/blacklisted-domains

**Description**: Adds a single domain to the blacklist.

**Method**: POST

**Endpoint**: /api/blacklisted-domains

### POST /api/blacklisted-domains/bulk

**Description**: Adds multiple domains to the blacklist in bulk.

**Method**: POST

**Endpoint**: /api/blacklisted-domains/bulk

### DELETE /api/blacklisted-domains/{blacklisted_domain_id}

**Description**: Removes a blacklisted domain by its ID.

**Method**: DELETE

**Endpoint**: /api/blacklisted-domains/{blacklisted_domain_id}
```

--------------------------------

### Generate Headless UI Token

Source: https://send.meetinboxxia.com/api/reference/index

Generates a headless UI token for authenticated workspace users, valid for up to 120 minutes. Used for embedding email connection views in partner apps.

```APIDOC
## POST /api/users/headless-ui-token

### Description
Generates a headless UI token for embedding email connection views in partner applications. The token is valid for 120 minutes.

### Method
POST

### Endpoint
/api/users/headless-ui-token

### Parameters
No parameters are required for this endpoint.

### Request Example
```bash
curl https://send.meetinboxxia.com/api/users/headless-ui-token \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **data.token** (string) - The generated headless UI token.

#### Response Example
```json
{
   "data": {
       "token": "headless_ui_token_rtG42rhsFhHq8rySjjaWh8RnaA"
   }
}
```
```

--------------------------------

### Campaigns v1.1 API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing campaign-related operations in version 1.1.

```APIDOC
## Campaigns v1.1 API

This section provides endpoints to manage campaign-related operations.

### GET /api/campaigns/v1.1/{campaign_id}/sequence-steps

**Description**: Retrieves sequence steps for a specific campaign.

**Method**: GET

**Endpoint**: /api/campaigns/v1.1/{campaign_id}/sequence-steps

### POST /api/campaigns/v1.1/{campaign_id}/sequence-steps

**Description**: Creates a new sequence step for a specific campaign.

**Method**: POST

**Endpoint**: /api/campaigns/v1.1/{campaign_id}/sequence-steps

### PUT /api/campaigns/v1.1/sequence-steps/{sequence_id}

**Description**: Updates a specific sequence step.

**Method**: PUT

**Endpoint**: /api/campaigns/v1.1/sequence-steps/{sequence_id}
```

--------------------------------

### Custom Lead Variables API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing custom variables created for a workspace.

```APIDOC
## Custom Lead Variables API

Here you can manage all custom variables created for a given workspace

### GET /api/custom-variables

**Description**: Retrieves a list of all custom lead variables.

**Method**: GET

**Endpoint**: /api/custom-variables

### POST /api/custom-variables

**Description**: Creates a new custom lead variable.

**Method**: POST

**Endpoint**: /api/custom-variables
```

--------------------------------

### Warmup API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing warmup settings for email accounts (sender emails).

```APIDOC
## Warmup Operations

### GET /api/warmup/sender-emails
**Description**: Retrieves a list of sender emails and their warmup settings.
**Method**: GET
**Endpoint**: /api/warmup/sender-emails

### PATCH /api/warmup/sender-emails/enable
**Description**: Enables warmup for sender emails.
**Method**: PATCH
**Endpoint**: /api/warmup/sender-emails/enable

### PATCH /api/warmup/sender-emails/disable
**Description**: Disables warmup for sender emails.
**Method**: PATCH
**Endpoint**: /api/warmup/sender-emails/disable

### PATCH /api/warmup/sender-emails/update-daily-warmup-limits
**Description**: Updates the daily warmup limits for sender emails.
**Method**: PATCH
**Endpoint**: /api/warmup/sender-emails/update-daily-warmup-limits

### GET /api/warmup/sender-emails/{senderEmailId}
**Description**: Retrieves warmup settings for a specific sender email.
**Method**: GET
**Endpoint**: /api/warmup/sender-emails/{senderEmailId}
```

--------------------------------

### Webhook Events API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing webhook events, sending test events, and viewing samples.

```APIDOC
## Webhook Events Operations

### GET /api/webhook-events/sample-payload
**Description**: Retrieves a sample payload for webhook events.
**Method**: GET
**Endpoint**: /api/webhook-events/sample-payload

### GET /api/webhook-events/event-types
**Description**: Retrieves a list of available webhook event types.
**Method**: GET
**Endpoint**: /api/webhook-events/event-types

### POST /api/webhook-events/test-event
**Description**: Sends a test webhook event.
**Method**: POST
**Endpoint**: /api/webhook-events/test-event
```

--------------------------------

### Leads API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing contact (lead) information, including creation, retrieval, updates, and bulk operations.

```APIDOC
## Leads Operations

### GET /api/leads
**Description**: Retrieves a list of leads.
**Method**: GET
**Endpoint**: /api/leads

### POST /api/leads
**Description**: Creates a new lead.
**Method**: POST
**Endpoint**: /api/leads

### GET /api/leads/{lead_id}
**Description**: Retrieves a specific lead by its ID.
**Method**: GET
**Endpoint**: /api/leads/{lead_id}

### PUT /api/leads/{lead_id}
**Description**: Updates a specific lead by its ID.
**Method**: PUT
**Endpoint**: /api/leads/{lead_id}

### PATCH /api/leads/{lead_id}
**Description**: Partially updates a specific lead by its ID.
**Method**: PATCH
**Endpoint**: /api/leads/{lead_id}

### DELETE /api/leads/{lead_id}
**Description**: Deletes a specific lead by its ID.
**Method**: DELETE
**Endpoint**: /api/leads/{lead_id}

### GET /api/leads/{lead_id}/replies
**Description**: Retrieves replies for a specific lead.
**Method**: GET
**Endpoint**: /api/leads/{lead_id}/replies

### POST /api/leads/multiple
**Description**: Creates multiple leads simultaneously.
**Method**: POST
**Endpoint**: /api/leads/multiple

### POST /api/leads/create-or-update/multiple
**Description**: Creates or updates multiple leads.
**Method**: POST
**Endpoint**: /api/leads/create-or-update/multiple

### POST /api/leads/create-or-update/{lead_id}
**Description**: Creates or updates a specific lead by its ID.
**Method**: POST
**Endpoint**: /api/leads/create-or-update/{lead_id}

### PATCH /api/leads/{lead_id}/unsubscribe
**Description**: Unsubscribes a specific lead.
**Method**: PATCH
**Endpoint**: /api/leads/{lead_id}/unsubscribe

### POST /api/leads/{lead_id}/blacklist
**Description**: Blacklists a specific lead.
**Method**: POST
**Endpoint**: /api/leads/{lead_id}/blacklist

### POST /api/leads/bulk/csv
**Description**: Uploads leads in bulk via CSV.
**Method**: POST
**Endpoint**: /api/leads/bulk/csv

### GET /api/leads/{lead_id}/scheduled-emails
**Description**: Retrieves scheduled emails for a specific lead.
**Method**: GET
**Endpoint**: /api/leads/{lead_id}/scheduled-emails

### GET /api/leads/{lead_id}/sent-emails
**Description**: Retrieves sent emails for a specific lead.
**Method**: GET
**Endpoint**: /api/leads/{lead_id}/sent-emails

### PATCH /api/leads/{lead_id}/update-status
**Description**: Updates the status of a specific lead.
**Method**: PATCH
**Endpoint**: /api/leads/{lead_id}/update-status

### PATCH /api/leads/bulk-update-status
**Description**: Updates the status of multiple leads in bulk.
**Method**: PATCH
**Endpoint**: /api/leads/bulk-update-status

### DELETE /api/leads/bulk
**Description**: Deletes multiple leads in bulk.
**Method**: DELETE
**Endpoint**: /api/leads/bulk
```

--------------------------------

### Generate Headless UI Token

Source: https://send.meetinboxxia.com/api/reference/index

Enables an authenticated workspace user to generate a headless UI token valid for up to 120 minutes. This token facilitates partner apps in generating embedded email account connection views without requiring full OAuth flows. A valid authentication token must be provided in the header. The generated token is used in a specific URL format to open an iframe for email connection flows.

```shell
curl https://send.meetinboxxia.com/api/users/headless-ui-token \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### Webhooks API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing webhooks, including listing, creating, retrieving, and deleting webhook URLs.

```APIDOC
## Webhooks API

APIs for managing webhooks. This includes listing, creating, retrieving and deleting webhook urls.

### GET /api/webhook-url

**Description**: Retrieves a list of all webhook URLs.

**Method**: GET

**Endpoint**: /api/webhook-url

### POST /api/webhook-url

**Description**: Creates a new webhook URL.

**Method**: POST

**Endpoint**: /api/webhook-url

### GET /api/webhook-url/{id}

**Description**: Retrieves a specific webhook URL by its ID.

**Method**: GET

**Endpoint**: /api/webhook-url/{id}

### PUT /api/webhook-url/{id}

**Description**: Updates a specific webhook URL by its ID.

**Method**: PUT

**Endpoint**: /api/webhook-url/{id}

### DELETE /api/webhook-url/{webhook_url_id}

**Description**: Deletes a webhook URL by its ID.

**Method**: DELETE

**Endpoint**: /api/webhook-url/{webhook_url_id}
```

--------------------------------

### Custom Tags API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing tags, including creating, retrieving, attaching to leads, and removing tags from leads.

```APIDOC
## Custom Tags API

APIs for managing tags. This includes creating, retrieving, attaching to leads, and removing tags from leads.

### GET /api/tags

**Description**: Retrieves a list of all custom tags.

**Method**: GET

**Endpoint**: /api/tags

### POST /api/tags

**Description**: Creates a new custom tag.

**Method**: POST

**Endpoint**: /api/tags

### GET /api/tags/{id}

**Description**: Retrieves a specific custom tag by its ID.

**Method**: GET

**Endpoint**: /api/tags/{id}

### DELETE /api/tags/{tag_id}

**Description**: Deletes a custom tag by its ID.

**Method**: DELETE

**Endpoint**: /api/tags/{tag_id}

### POST /api/tags/attach-to-campaigns

**Description**: Attaches tags to campaigns.

**Method**: POST

**Endpoint**: /api/tags/attach-to-campaigns

### POST /api/tags/remove-from-campaigns

**Description**: Removes tags from campaigns.

**Method**: POST

**Endpoint**: /api/tags/remove-from-campaigns

### POST /api/tags/attach-to-leads

**Description**: Attaches tags to leads.

**Method**: POST

**Endpoint**: /api/tags/attach-to-leads

### POST /api/tags/remove-from-leads

**Description**: Removes tags from leads.

**Method**: POST

**Endpoint**: /api/tags/remove-from-leads

### POST /api/tags/attach-to-sender-emails

**Description**: Attaches tags to sender emails.

**Method**: POST

**Endpoint**: /api/tags/attach-to-sender-emails

### POST /api/tags/remove-from-sender-emails

**Description**: Removes tags from sender emails.

**Method**: POST

**Endpoint**: /api/tags/remove-from-sender-emails
```

--------------------------------

### Reply Templates API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing reply templates, which can be used as templated responses for leads.

```APIDOC
## Reply Templates Operations

### GET /api/reply-templates
**Description**: Retrieves a list of reply templates.
**Method**: GET
**Endpoint**: /api/reply-templates

### POST /api/reply-templates
**Description**: Creates a new reply template.
**Method**: POST
**Endpoint**: /api/reply-templates

### GET /api/reply-templates/{id}
**Description**: Retrieves a specific reply template by its ID.
**Method**: GET
**Endpoint**: /api/reply-templates/{id}

### PUT /api/reply-templates/{id}
**Description**: Updates a specific reply template by its ID.
**Method**: PUT
**Endpoint**: /api/reply-templates/{id}

### DELETE /api/reply-templates/{reply_template_id}
**Description**: Deletes a specific reply template by its ID.
**Method**: DELETE
**Endpoint**: /api/reply-templates/{reply_template_id}
```

--------------------------------

### Email Accounts API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing email accounts, including listing, retrieving, creating, testing connections, and deleting accounts.

```APIDOC
## Email Accounts API

This section provides endpoints to manage email accounts associated with a workspace. It includes functionalities for listing all email accounts, retrieving details of a specific email account, creating new IMAP/SMTP email accounts, testing IMAP and SMTP connections, and deleting existing email accounts.

### GET /api/sender-emails

**Description**: Retrieves a list of all sender email accounts.

**Method**: GET

**Endpoint**: /api/sender-emails

### GET /api/sender-emails/{senderEmailId}/campaigns

**Description**: Retrieves campaigns associated with a specific sender email account.

**Method**: GET

**Endpoint**: /api/sender-emails/{senderEmailId}/campaigns

### GET /api/sender-emails/{senderEmailId}

**Description**: Retrieves details of a specific sender email account.

**Method**: GET

**Endpoint**: /api/sender-emails/{senderEmailId}

### PATCH /api/sender-emails/{senderEmailId}

**Description**: Updates a specific sender email account.

**Method**: PATCH

**Endpoint**: /api/sender-emails/{senderEmailId}

### DELETE /api/sender-emails/{senderEmailId}

**Description**: Deletes a specific sender email account.

**Method**: DELETE

**Endpoint**: /api/sender-emails/{senderEmailId}

### GET /api/sender-emails/{senderEmailId}/replies

**Description**: Retrieves replies associated with a specific sender email account.

**Method**: GET

**Endpoint**: /api/sender-emails/{senderEmailId}/replies

### GET /api/sender-emails/{senderEmailId}/oauth-access-token

**Description**: Retrieves the OAuth access token for a specific sender email account.

**Method**: GET

**Endpoint**: /api/sender-emails/{senderEmailId}/oauth-access-token

### PATCH /api/sender-emails/signatures/bulk

**Description**: Updates signatures for multiple sender email accounts in bulk.

**Method**: PATCH

**Endpoint**: /api/sender-emails/signatures/bulk

### PATCH /api/sender-emails/daily-limits/bulk

**Description**: Updates daily limits for multiple sender email accounts in bulk.

**Method**: PATCH

**Endpoint**: /api/sender-emails/daily-limits/bulk

### POST /api/sender-emails/imap-smtp

**Description**: Creates a new IMAP/SMTP email account.

**Method**: POST

**Endpoint**: /api/sender-emails/imap-smtp

### POST /api/sender-emails/bulk

**Description**: Creates multiple sender email accounts in bulk.

**Method**: POST

**Endpoint**: /api/sender-emails/bulk

### POST /api/sender-emails/{senderEmailId}/check-mx-records

**Description**: Checks MX records for a specific sender email account.

**Method**: POST

**Endpoint**: /api/sender-emails/{senderEmailId}/check-mx-records

### POST /api/sender-emails/bulk-check-missing-mx-records

**Description**: Checks for missing MX records for multiple sender email accounts in bulk.

**Method**: POST

**Endpoint**: /api/sender-emails/bulk-check-missing-mx-records
```

--------------------------------

### Custom Tracking Domains API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing custom tracking domains, including retrieving, creating, and removing domains.

```APIDOC
## Custom Tracking Domains API

APIs for managing custom tracking domains. This includes retrieving, creating, and removing custom tracking domains.

### GET /api/custom-tracking-domain

**Description**: Retrieves a list of all custom tracking domains.

**Method**: GET

**Endpoint**: /api/custom-tracking-domain

### POST /api/custom-tracking-domain

**Description**: Creates a new custom tracking domain.

**Method**: POST

**Endpoint**: /api/custom-tracking-domain

### GET /api/custom-tracking-domain/{id}

**Description**: Retrieves a specific custom tracking domain by its ID.

**Method**: GET

**Endpoint**: /api/custom-tracking-domain/{id}

### DELETE /api/custom-tracking-domain/{custom_tracking_domain_id}

**Description**: Deletes a custom tracking domain by its ID.

**Method**: DELETE

**Endpoint**: /api/custom-tracking-domain/{custom_tracking_domain_id}
```

--------------------------------

### Workspaces v1 (deprecated) API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing workspace-related operations (deprecated). Includes functionalities for creating, updating, and deleting workspaces.

```APIDOC
## Workspaces v1 (deprecated) Operations

### GET /api/workspaces
**Description**: Retrieves a list of workspaces.
**Method**: GET
**Endpoint**: /api/workspaces

### POST /api/workspaces
**Description**: Creates a new workspace.
**Method**: POST
**Endpoint**: /api/workspaces

### POST /api/workspaces/switch-workspace
**Description**: Switches the active workspace.
**Method**: POST
**Endpoint**: /api/workspaces/switch-workspace

### PUT /api/workspaces/{team_id}
**Description**: Updates a workspace by its ID.
**Method**: PUT
**Endpoint**: /api/workspaces/{team_id}

### GET /api/workspaces/{team_id}
**Description**: Retrieves a specific workspace by its ID.
**Method**: GET
**Endpoint**: /api/workspaces/{team_id}

### POST /api/workspaces/invite-members
**Description**: Invites members to a workspace.
**Method**: POST
**Endpoint**: /api/workspaces/invite-members

### POST /api/workspaces/accept/{team_invitation_id}
**Description**: Accepts a workspace invitation.
**Method**: POST
**Endpoint**: /api/workspaces/accept/{team_invitation_id}

### PUT /api/workspaces/members/{user_id}
**Description**: Updates a workspace member's details.
**Method**: PUT
**Endpoint**: /api/workspaces/members/{user_id}

### DELETE /api/workspaces/members/{user_id}
**Description**: Removes a member from a workspace.
**Method**: DELETE
**Endpoint**: /api/workspaces/members/{user_id}
```

--------------------------------

### Campaigns Operations

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing campaign-related operations, including creation, duplication, scheduling, and statistics.

```APIDOC
## Campaigns API Endpoints

This section provides endpoints to manage campaign-related operations.

### Get Campaigns
- **Method**: GET
- **Endpoint**: `/api/campaigns`

### Create Campaign
- **Method**: POST
- **Endpoint**: `/api/campaigns`

### Duplicate Campaign
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/duplicate`

### Pause Campaign
- **Method**: PATCH
- **Endpoint**: `/api/campaigns/{campaign_id}/pause`

### Resume Campaign
- **Method**: PATCH
- **Endpoint**: `/api/campaigns/{campaign_id}/resume`

### Archive Campaign
- **Method**: PATCH
- **Endpoint**: `/api/campaigns/{campaign_id}/archive`

### Update Campaign
- **Method**: PATCH
- **Endpoint**: `/api/campaigns/{id}/update`

### Schedule Campaign
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/schedule`

### Get Campaign Schedule
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/schedule`

### Update Campaign Schedule
- **Method**: PUT
- **Endpoint**: `/api/campaigns/{campaign_id}/schedule`

### Get Schedule Templates
- **Method**: GET
- **Endpoint**: `/api/campaigns/schedule/templates`

### Get Available Timezones
- **Method**: GET
- **Endpoint**: `/api/campaigns/schedule/available-timezones`

### Get Sending Schedules
- **Method**: GET
- **Endpoint**: `/api/campaigns/sending-schedules`

### Get Campaign Sending Schedule
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/sending-schedule`

### Create Schedule from Template
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/create-schedule-from-template`

### Get Campaign Sequence Steps
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/sequence-steps`

### Add Campaign Sequence Step
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/sequence-steps`

### Update Campaign Sequence Step
- **Method**: PUT
- **Endpoint**: `/api/campaigns/sequence-steps/{sequence_id}`

### Delete Campaign Sequence Step
- **Method**: DELETE
- **Endpoint**: `/api/campaigns/sequence-steps/{sequence_step_id}`

### Test Campaign Sequence Step Email
- **Method**: POST
- **Endpoint**: `/api/campaigns/sequence-steps/{sequence_step_id}/test-email`

### Get Campaign Replies
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/replies`

### Get Campaign Leads
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/leads`

### Delete Campaign Leads
- **Method**: DELETE
- **Endpoint**: `/api/campaigns/{campaign_id}/leads`

### Attach Lead List to Campaign
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/leads/attach-lead-list`

### Attach Leads to Campaign
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/leads/attach-leads`

### Stop Future Emails for Campaign Leads
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/leads/stop-future-emails`

### Get Campaign Scheduled Emails
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/scheduled-emails`

### Get Campaign Sender Emails
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/sender-emails`

### Post Campaign Stats
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/stats`

### Attach Sender Emails to Campaign
- **Method**: POST
- **Endpoint**: `/api/campaigns/{campaign_id}/attach-sender-emails`

### Remove Sender Emails from Campaign
- **Method**: DELETE
- **Endpoint**: `/api/campaigns/{campaign_id}/remove-sender-emails`

### Get Campaign Line Area Chart Stats
- **Method**: GET
- **Endpoint**: `/api/campaigns/{campaign_id}/line-area-chart-stats`

### Get Specific Campaign
- **Method**: GET
- **Endpoint**: `/api/campaigns/{id}`

### Bulk Delete Campaigns
- **Method**: DELETE
- **Endpoint**: `/api/campaigns/bulk`

### Delete Specific Campaign
- **Method**: DELETE
- **Endpoint**: `/api/campaigns/{campaign_id}`
```

--------------------------------

### Email Blacklist API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing blacklisted emails, including retrieving, creating, bulk creating, and removing emails.

```APIDOC
## Email Blacklist API

APIs for managing blacklisted emails. This includes retrieving, creating, bulk creating, and removing blacklisted emails.

### GET /api/blacklisted-emails

**Description**: Retrieves a list of blacklisted emails.

**Method**: GET

**Endpoint**: /api/blacklisted-emails

### POST /api/blacklisted-emails

**Description**: Adds a single email to the blacklist.

**Method**: POST

**Endpoint**: /api/blacklisted-emails

### POST /api/blacklisted-emails/bulk

**Description**: Adds multiple emails to the blacklist in bulk.

**Method**: POST

**Endpoint**: /api/blacklisted-emails/bulk

### DELETE /api/blacklisted-emails/{blacklisted_email_id}

**Description**: Removes a blacklisted email by its ID.

**Method**: DELETE

**Endpoint**: /api/blacklisted-emails/{blacklisted_email_id}
```

--------------------------------

### Replies API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for managing replies, including retrieving, updating, and organizing reply threads.

```APIDOC
## Replies API

This section provides endpoints to manage replies. It includes functionalities for retrieving, updating, and managing replies.

### GET /api/replies

**Description**: Retrieves a list of replies.

**Method**: GET

**Endpoint**: /api/replies

### GET /api/replies/{id}

**Description**: Retrieves a specific reply by its ID.

**Method**: GET

**Endpoint**: /api/replies/{id}

### POST /api/replies/new

**Description**: Creates a new reply.

**Method**: POST

**Endpoint**: /api/replies/new

### POST /api/replies/{reply_id}/reply

**Description**: Sends a reply to an existing reply.

**Method**: POST

**Endpoint**: /api/replies/{reply_id}/reply

### POST /api/replies/{reply_id}/forward

**Description**: Forwards an existing reply.

**Method**: POST

**Endpoint**: /api/replies/{reply_id}/forward

### PATCH /api/replies/{reply_id}/mark-as-interested

**Description**: Marks a reply as interested.

**Method**: PATCH

**Endpoint**: /api/replies/{reply_id}/mark-as-interested

### PATCH /api/replies/{reply_id}/mark-as-not-interested

**Description**: Marks a reply as not interested.

**Method**: PATCH

**Endpoint**: /api/replies/{reply_id}/mark-as-not-interested

### PATCH /api/replies/{reply_id}/mark-as-read-or-unread

**Description**: Marks a reply as read or unread.

**Method**: PATCH

**Endpoint**: /api/replies/{reply_id}/mark-as-read-or-unread

### PATCH /api/replies/{reply_id}/mark-as-automated-or-not-automated

**Description**: Marks a reply as automated or not automated.

**Method**: PATCH

**Endpoint**: /api/replies/{reply_id}/mark-as-automated-or-not-automated

### PATCH /api/replies/{reply_id}/unsubscribe

**Description**: Unsubscribes a reply.

**Method**: PATCH

**Endpoint**: /api/replies/{reply_id}/unsubscribe

### DELETE /api/replies/{reply_id}

**Description**: Deletes a reply by its ID.

**Method**: DELETE

**Endpoint**: /api/replies/{reply_id}

### GET /api/replies/{reply_id}/conversation-thread

**Description**: Retrieves the conversation thread for a given reply.

**Method**: GET

**Endpoint**: /api/replies/{reply_id}/conversation-thread

### POST /api/replies/{reply_id}/attach-scheduled-email-to-reply

**Description**: Attaches a scheduled email to a reply.

**Method**: POST

**Endpoint**: /api/replies/{reply_id}/attach-scheduled-email-to-reply

### POST /api/replies/{reply_id}/followup-campaign/push

**Description**: Pushes a followup campaign to a reply.

**Method**: POST

**Endpoint**: /api/replies/{reply_id}/followup-campaign/push
```

--------------------------------

### Ignore Phrases API

Source: https://send.meetinboxxia.com/api/reference/index

APIs for managing ignore phrases, including retrieving, creating, and removing phrases.

```APIDOC
## Ignore Phrases API

APIs for managing ignore phrases. This includes retrieving, creating, and removing ignore phrases.

### GET /api/ignore-phrases

**Description**: Retrieves a list of all ignore phrases.

**Method**: GET

**Endpoint**: /api/ignore-phrases

### POST /api/ignore-phrases

**Description**: Creates a new ignore phrase.

**Method**: POST

**Endpoint**: /api/ignore-phrases

### GET /api/ignore-phrases/{ignore_phrase_id}

**Description**: Retrieves a specific ignore phrase by its ID.

**Method**: GET

**Endpoint**: /api/ignore-phrases/{ignore_phrase_id}

### DELETE /api/ignore-phrases/{ignore_phrase_id}

**Description**: Deletes an ignore phrase by its ID.

**Method**: DELETE

**Endpoint**: /api/ignore-phrases/{ignore_phrase_id}
```

--------------------------------

### POST /api/users/profile-picture

Source: https://send.meetinboxxia.com/api/reference/index

Allows the authenticated user to update their profile picture. Requires a valid authentication token and a valid image file in the request body.

```APIDOC
## POST /api/users/profile-picture

### Description
This endpoint allows the authenticated user to update their profile information, specifically their profile picture. The user must provide a valid authentication token in the request header to access this endpoint.

### Method
POST

### Endpoint
/api/users/profile-picture

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **photo** (string) - Required - The new profile picture to update. Must be a valid image file (jpg, jpeg or png) and no larger than 1MB.

### Request Example
```curl
curl https://send.meetinboxxia.com/api/users/profile-picture \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --form 'photo='
```

### Response
#### Success Response (200)
- **data** (object) - Updated user details, including the new profile photo path and URL.

#### Response Example
```json
{
  "data": {
    "id": 1,
    "name": "John Doe",
    "email": "john@doe.com",
    "team": {
      "id": 1,
      "name": "John Doe's Team",
      "personal_team": true,
      "main": true,
      "parent_id": null,
      "total_monthly_email_verification_credits": 0,
      "remaining_monthly_email_verification_credits": 0,
      "remaining_email_verification_credits": 0,
      "total_email_verification_credits": 0,
      "sender_email_limit": 100000,
      "warmup_limit": 100000,
      "warmup_filter_phrase": null,
      "has_access_to_warmup": false,
      "has_access_to_healthcheck": false,
      "created_at": "2025-04-14T16:59:21.000000Z",
      "updated_at": "2025-05-18T12:53:32.000000Z"
    },
    "profile_photo_path": "https://emailbison.s3.amazonaws.com/v2/images/1/f24c3135-9f3a-46f5-ac1c-139271a72cd9.jpg",
    "profile_photo_url": "https://ui-avatars.com/api/?name=J&color=7F9CF5&background=EBF4FF",
    "created_at": "2025-04-14T16:59:21.000000Z",
    "updated_at": "2025-05-18T12:53:32.000000Z"
  }
}
```
```

--------------------------------

### Campaign Events API

Source: https://send.meetinboxxia.com/api/reference/index

Endpoints for drilling down into campaign event statistics based on dates, campaign IDs, and/or sender email IDs.

```APIDOC
## Campaign Events API

Drill down into campaign event stats based on dates, campaign IDs, and/or sender email IDs

### GET /api/campaign-events/stats

**Description**: Retrieves statistics for campaign events.

**Method**: GET

**Endpoint**: /api/campaign-events/stats
```

--------------------------------

### Update User Password

Source: https://send.meetinboxxia.com/api/reference/index

Allows an authenticated user to update their password. Requires a valid authentication token in the header and the current password, new password, and password confirmation in the JSON body. Returns a success message upon successful update.

```shell
curl https://send.meetinboxxia.com/api/users/password \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{ \
  "current_password": "password", \
  "password": "new-password", \
  "password_confirmation": "new-password" \
}'
```

--------------------------------

### Update Profile Picture using Curl

Source: https://send.meetinboxxia.com/api/reference/index

Allows the authenticated user to update their profile picture. Requires a valid Bearer token and a multipart/form-data request with the 'photo' field. Accepts JPG, JPEG, or PNG files up to 1MB.

```shell
curl https://send.meetinboxxia.com/api/users/profile-picture \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --form 'photo='
```

--------------------------------

### Update Password

Source: https://send.meetinboxxia.com/api/reference/index

Allows the authenticated user to update their password. Requires a valid authentication token in the request header.

```APIDOC
## PUT /api/users/password

### Description
Updates the password for the authenticated user.

### Method
PUT

### Endpoint
/api/users/password

### Parameters
#### Request Body
- **current_password** (string) - Required - Your current password.
- **password** (string) - Required - Your new password.
- **password_confirmation** (string) - Required - Your new password repeated.

### Request Example
```json
{
  "current_password": "password",
  "password": "new-password",
  "password_confirmation": "new-password"
}
```

### Response
#### Success Response (200)
- **data.success** (boolean) - Indicates if the password update was successful.
- **data.message** (string) - A message confirming the password update.

#### Response Example
```json
{
  "data": {
    "success": true,
    "message": "Successfully updated your profile password"
  }
}
```
```
Tokens:
Raw