API Reference/Endpoints

Act on a member profile

POST/api/linkedin/gateway/linkedin/user/{user_id}

One route for a handful of premium-seat actions taken against a specific profile: moving a Recruiter candidate through a pipeline, rejecting an applicant, or saving a profile as a Sales Navigator lead. Which fields apply depends on the api and action you send.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Path parameters

FieldTypeDescription

user_id *stringThe target profile's provider id.

Body parameters — Recruiter pipeline

api: "recruiter", requires an active Recruiter contract on the account.

·action "addCandidateToPipeline", "addApplicantToPipeline", or "changeCandidatePipeline".·hiring_project_id (required) Which project's pipeline to place the member into.·stage "UNCONTACTED", "CONTACTED", or "REPLIED". Defaults to UNCONTACTED.

Body parameters — Recruiter rejection

api: "recruiter", action: "rejectApplicant".

·hiring_project_id (required) Which project the applicant belongs to.·reason (required) One of "NOT_MEET_BASIC_QUALIFICATIONS", "NOT_IN_DESIRED_LOCATION", "MORE_QUALIFIED_CANDIDATES", "WITHDREW_APPLICATION", or "NOT_CONSIDERED_OR_REASON_NOT_SPECIFIED".·rejection_notification Optional { send_notification_at, message }. Omit it entirely to reject without notifying the applicant.

Body parameters — Sales Navigator

api: "sales_navigator", action: "saveLead".

·list_id Which saved-lead list to file the profile under. Omit to use the default list.

Response fields

FieldTypeDescription

object"LinkedinPerformActionOnUser"Always this value.

successbooleanWhether the action went through.

Errors

·400 Bad Request. account_id, api or action is missing, or a field required for that action/api combination is missing.·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key, or the account has no contract for that api.·404 Not Found. No member, hiring project, or list exists for the given id.·422 Unprocessable Entity. This action was already performed on this member (e.g. already added to that pipeline).