Network

Preview withdrawing invitations

Count the sent invitations a withdrawal would take back, per campaign.

Pass campaignId or linkedinConnectionId, exactly one.

Only invitations a campaign sent are counted, and only those pending at least daysThreshold days and at most 42.

When nothing qualifies the answer is a plain sentence, not an object.

Docs: https://heyreagent.com/docs/actions/preview_withdraw_invitations

post/v1/actions/preview_withdraw_invitations

Request

  • Base URL: https://api.heyreagent.com
  • URL: https://api.heyreagent.com/v1/actions/preview_withdraw_invitations
  • Auth: HTTP bearer

Request body

campaignIdstring

ID of a specific campaign to withdraw invites for. Provide either campaignId OR linkedinConnectionId, not both.

linkedinConnectionIdstring

LinkedIn sender account ID. When provided (without campaignId), withdraws eligible invites across ALL campaigns using this account.

daysThresholdnumber

Only withdraw invites that have been pending for at least this many days (default: 7).

withdrawLimitnumber

Max number of profiles to withdraw per campaign run. Omit for no limit.

Response

It worked. Inside result: summary, breakdown.

oktrue required
resultobject required

What was asked for. A field that does not apply is left out, or is null.

Changes

No recorded changes to this operation across all 1 revision of this API.