> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Unipile: Send Invitation

> Sends a real connection request (LinkedIn invitation, optionally with a note) or follow from the customer’s connected account.

Sends a real connection request (LinkedIn invitation, optionally with a note) or follow from the customer’s connected account.

> [!NOTE]
>
> Tool ID: `unipile_send_invitation`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_send_invitation',
  {
    "provider_id": "provider_123",
    "account_id": "123456789"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_send_invitation --input '{
  "provider_id": "provider_123",
  "account_id": "123456789"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "UserInvitationSent",
    "invitation_id": "invitation_123"
  }
}
```

Use `deepline describe unipile_send_invitation --json` for the latest machine-readable contract.

## Input reference

Send an invitation to add someone to your contacts. Ensure careful implementation of this action and consult provider limits and restrictions: [https://developer.unipile.com/docs/provider-limits-and-restrictions](https://developer.unipile.com/docs/provider-limits-and-restrictions)

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.provider_id` | `string` | Yes | — | The id of the user to add. It has to be the provider’s id. LinkedIn Classic: inviting the connected account's own profile returns HTTP 422 (errors/cannot\_invite\_attendee). `Instagram`: You can use the provider\_id or the username of the user. The provider\_messaging\_id dont work on this route ! |
| `payload.account_id` | `string` | Yes | — | The id of the account where the user will be added. |
| `payload.user_email` | `string` | No | — | The email address of the user when it's required (Linkedin specific). Format: `emailLike`. |
| `payload.message` | `string` | No | — | An optional message to go with the invitation (max 300 chars). Maximum length: 300. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Send an invitation to add someone to your contacts. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions",
    "properties": {
      "provider_id": {
        "type": "string",
        "description": "The id of the user to add. It has to be the provider’s id. LinkedIn Classic: inviting the connected account's own profile returns HTTP 422 (errors/cannot_invite_attendee). `Instagram`: You can use the provider_id or the username of the user. The provider_messaging_id dont work on this route !"
      },
      "account_id": {
        "type": "string",
        "description": "The id of the account where the user will be added."
      },
      "user_email": {
        "type": "string",
        "description": "The email address of the user when it's required (Linkedin specific).",
        "format": "emailLike"
      },
      "message": {
        "type": "string",
        "description": "An optional message to go with the invitation (max 300 chars).",
        "maxLength": 300
      }
    },
    "required": [
      "provider_id",
      "account_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"UserInvitationSent"` | Yes | — | Allowed: `UserInvitationSent`. |
| `result.data.invitation_id` | `string` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "UserInvitationSent"
            ]
          },
          "invitation_id": {
            "type": "string"
          }
        },
        "required": [
          "object",
          "invitation_id"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.