Skip a step from the side panel

curl --request POST \
  --url https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/"

payload = { "reason": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "claimed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123,
  "error_code": "selector_missing",
  "error_message": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "profile_view",
  "outcome": {
    "already_connected": true,
    "already_following": true,
    "can_send_message": true,
    "invitation_pending": true,
    "kind": "profile_view",
    "member_urn": "<string>",
    "member_urns": [
      "<string>"
    ],
    "open_profile": true,
    "page_loaded": true,
    "profile_resolved": true,
    "reason": "invitation_already_pending",
    "vanity": "<string>"
  },
  "params": {
    "profile_url": "<string>",
    "kind": "profile_view",
    "read_relationship": false
  },
  "queued_at": "2023-11-07T05:31:56Z",
  "status": "queued",
  "acted_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "held": false,
  "hold": "sequence_paused",
  "metered": true,
  "requires_approval": false
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

agent

actions

{action_id}

reject

Skip a step from the side panel

curl --request POST \
  --url https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'

import requests

url = "https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/"

payload = { "reason": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>'})
};

fetch('https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/linkedin/agent/actions/{action_id}/reject/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "claimed_at": "2023-11-07T05:31:56Z",
  "duration_ms": 123,
  "error_code": "selector_missing",
  "error_message": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "profile_view",
  "outcome": {
    "already_connected": true,
    "already_following": true,
    "can_send_message": true,
    "invitation_pending": true,
    "kind": "profile_view",
    "member_urn": "<string>",
    "member_urns": [
      "<string>"
    ],
    "open_profile": true,
    "page_loaded": true,
    "profile_resolved": true,
    "reason": "invitation_already_pending",
    "vanity": "<string>"
  },
  "params": {
    "profile_url": "<string>",
    "kind": "profile_view",
    "read_relationship": false
  },
  "queued_at": "2023-11-07T05:31:56Z",
  "status": "queued",
  "acted_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "held": false,
  "hold": "sequence_paused",
  "metered": true,
  "requires_approval": false
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

action_id

string<uuid>

required

Body

application/json

reason

string | null

Maximum string length: 200

Response

Successful Response

One LinkedIn step, in the shape the dashboard and every extension build read.

A step is queued only once it may run (its approval, when one was asked for, happened on Tasks before it was queued), so every step reads approved_at as the moment it was queued and requires_approval false: the extension's store builds draw "Approve tasks" from exactly these two fields, and no step in the line waits for a person. hold is kept for the same builds and is always null: whether a step is out of the line is held.

account_id

string<uuid>

required

claimed_at

string<date-time> | null

required

duration_ms

integer | null

required

error_code

enum<string> | null

required

Why one action did not succeed, as a closed vocabulary.

Two populations in one enum, on purpose. The first twelve are reported by the browser agent and were previously a free string that only the extension had written down, so nothing stopped a typo storing and rendering exactly like a real code. The last four the backend writes itself: three when an action settles without the browser ever running it, and CLAIM_EXPIRED when the browser took a step and then went silent, so nobody can say whether it ran.

The list is the whole contract: a code outside it is rejected at the API boundary rather than persisted, so the extension and the dashboard can only ever speak about failures both sides can name.

Available options:

selector_missing,

blocked_checkpoint,

not_authenticated,

account_mismatch,

navigation_failed,

timed_out,

linkedin_error,

agent_restarted,

tab_lost,

not_applicable,

not_connected,

invalid_params,

user_rejected,

cancelled,

missed_window,

sender_changed,

claim_expired,

interrupted_repeatedly

error_message

string | null

required

finished_at

string<date-time> | null

required

string<uuid>

required

kind

enum<string>

required

What the browser agent is being asked to do.

The four CHECK_*/READ_* kinds are housekeeping: they read our own outbound invitations, our own newest connections and our own conversations to detect what the contact did, so they are free and deliberately excluded from the priced kinds below.

CHECK_CONNECTIONS reads the first batch of the sender's connections list, newest first: a person found there has accepted, whenever the invitation went out. It is how an acceptance is noticed at all once an invitation has fallen out of the ten rows the sent list shows a background tab.

CHECK_INBOX scans the conversation list for threads with new inbound activity; READ_CONVERSATION opens one of them and reads it in full. The split keeps LinkedIn activity proportional to real replies: the cheap scan runs on every sweep, the expensive read only where the scan saw a change.

LIKE_LATEST_POST targets the contact's most recent post at the moment the browser runs it. A contact with no posts is not a failure: the driver reports the action SKIPPED, and the sequence advances either way.

Every profile-targeted outcome carries the facts the browser read off the profile, including the three-state Premium "Open Profile" reading; see the section comment above the outcome models.

Available options:

profile_view,

connection_request,

send_message,

inmail,

withdraw_connection_request,

follow_contact,

like_latest_post,

check_sent_invitations,

check_connections,

check_inbox,

read_conversation

outcome

ProfileViewOutcome · object

required

What a profile view saw: the common fields and the nine profile facts.

The view IS the action: LinkedIn records it server-side the moment the page renders, so page_loaded is the verification and a view whose facts all read None is still a completed view. How long the browser lingered and how far it scrolled are the driver's pacing, not facts about the member, and the row's own duration_ms already says how long the step took.

Show child attributes

params

ProfileViewParams · object

required

Open a member's profile and read it like a person would. The navigation is the action.

profile_url is where the browser goes first. read_relationship asks the browser to settle whether the member is connected or has our invitation pending even where the action bar does not show it, by opening the member's own More menu and reading it: the look a connection request queues when its answer cannot be told any other way.

Show child attributes

queued_at

string<date-time>

required

status

enum<string>

required

Where one queued action stands.

Governor-deferral is deliberately NOT a status: an action whose kind has hit its daily cap stays QUEUED and is simply not handed out, with the reason travelling on the hand-out response instead. A DEFERRED row would make the queue lie about what is still waiting to happen.

SKIPPED is "not applicable" (no LinkedIn URL, already connected); REJECTED is "a human refused it"; FAILED is "we tried and could not".

RESUMING is a step put back in line after an attempt that may have acted on LinkedIn (its browser was granted the press, or lost track of the step): it is never "queued", so no path that assumes nothing happened yet (moving it to another sender, a plain copy, "did not run") ever reads it as such, and it is handed only to a browser that checks LinkedIn before acting.

Available options:

queued,

resuming,

claimed,

succeeded,

failed,

rejected,

skipped

acted_at

string<date-time> | null

When the step said it acted on LinkedIn, for a result that arrived late. On a failed step it means the step happened after all: it stays failed for a person, and a Retry checks LinkedIn first and never sends it twice.

approved_at

string<date-time> | null

When the step was let run: the moment it was queued, since a step is queued only once it may run. Kept for older extension builds.

held

boolean

default:false

Whether the step is held out of every browser's line, because its paused sequence or paused contact holds it. It runs once they are resumed. Only the dashboard's queue lists a held step that is waiting; a browser is never sent one.

hold

enum<string> | null

Always null; read held. Kept for older extension builds.

Available options:

sequence_paused,

contact_paused

metered

boolean

default:true

Whether the step spends the sender's limits and credit. False for a step the Oneprofile team fired to test the sender: it goes first, waits for no gap and counts against no limit.

requires_approval

boolean

default:false

Always false: a step that asks for a person waits on Oneprofile's Tasks page, never in the line. Kept for older extension builds.

API reference

Endpoints

Skip a step from the side panel

Authorizations

Path Parameters

Body

Response