Docs / Network

`withdraw_invitations`

Take back sent invitations that are still unanswered, in the background.

This action can change or spend something, and when it does it happens right away. Read “Good to know” first.

What you give it

Input	What it is	Where to get it
`campaignId` optional	A campaign id. ID of a specific campaign to withdraw invites for. Provide either campaignId OR linkedinConnectionId, not both.	Run `preview_withdraw_invitations` and use `breakdown[].campaignId` from its answer.
`linkedinConnectionId` optional	A connection id. LinkedIn sender account ID. When provided (without campaignId), withdraws eligible invites across ALL campaigns using this account.	Run `list_linkedin_accounts` and use `accounts[].id` from its answer. 15 more places to get it `get_my_profile` → `accounts[].connectionId` `list_connections` → `connections[].connectionId` `list_connections` → `summary.accounts[].connectionId` `list_sent_invitations` → `pendingInvitations[].connectionId` `preview_withdraw_invitations` → `breakdown[].linkedinConnectionId` `list_conversations` → `inbox[].linkedinConnectionId` `list_inmail` → `inmail[].connectionId` `get_inmail_credits` → `accounts[].connectionId` `list_sales_navigator_contracts` → `accounts[].connectionId` `who_is_waiting_on_me` → `waitingOnYou[].connectionId` `who_went_cold` → `coldConversations[].connectionId` `connections_never_messaged` → `summary.accounts[].connectionId` `get_usage` → `connectionId` `get_conversation` → `connectionId` `get_inmail_conversation` → `connectionId`
`daysThreshold` optional	A number, 1 to 90. Only withdraw invites that have been pending for at least this many days (default: 7).	You write it.
`withdrawLimit` optional	A number, 1 to 500. Max number of profiles to withdraw per campaign run. Omit for no limit.	You write it.

Call it

curl -X POST https://api.heyreagent.com/v1/actions/withdraw_invitations \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"linkedinConnectionId":"PASTE_CONNECTION_ID_HERE"}'

The same call in JavaScript

const response = await fetch("https://api.heyreagent.com/v1/actions/withdraw_invitations", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "linkedinConnectionId": "PASTE_CONNECTION_ID_HERE"
  }),
});
const answer = await response.json();
console.log(answer);

The same call in Python

import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/withdraw_invitations",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "linkedinConnectionId": "PASTE_CONNECTION_ID_HERE",
    },
)
print(response.json())

The same call in n8n

Add an HTTP Request node and fill it in like this:

Method	`POST`
URL	`https://api.heyreagent.com/v1/actions/withdraw_invitations`
Send Headers	On. Name `Authorization`, Value `Bearer YOUR_KEY`
Send Body	On. Body Content Type `JSON`, Specify Body `Using JSON`, then paste the body below

{
  "linkedinConnectionId": "PASTE_CONNECTION_ID_HERE"
}

Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

`success`
`summary`
`tasks`

A field that does not apply to an answer is left out, or is null.

When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.

Good to know

Same inputs and rules as preview_withdraw_invitations; run that first. To take back ONE invitation now, whoever sent it, use withdraw_invitation.
It queues the work and answers at once. tasks[].taskId is not a task id that get_send_status takes.
Calling it twice queues the same withdrawal twice.

In Claude or ChatGPT

Once connected, ask in your own words. The assistant sees this action as a tool with the same name, withdraw_invitations, and the same inputs.