> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# unipile-linkedin
> Unipile LinkedIn - profiles, search, jobs, and social
**Server path:** `/unipile-linkedin` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [`unipile_linkedin_add_post_reaction`](#unipile_linkedin_add_post_reaction) | Add a reaction to a post |
| [`unipile_linkedin_add_user_by_identifier`](#unipile_linkedin_add_user_by_identifier) | Send an invitation |
| [`unipile_linkedin_cancel_invitation`](#unipile_linkedin_cancel_invitation) | Cancel an invitation |
| [`unipile_linkedin_close_job_posting`](#unipile_linkedin_close_job_posting) | Close a job posting |
| [`unipile_linkedin_create_job_posting`](#unipile_linkedin_create_job_posting) | Create a job posting |
| [`unipile_linkedin_create_post`](#unipile_linkedin_create_post) | Create a post |
| [`unipile_linkedin_edit_account_owner_profile`](#unipile_linkedin_edit_account_owner_profile) | Edit own profile |
| [`unipile_linkedin_edit_job_posting`](#unipile_linkedin_edit_job_posting) | Edit a job posting |
| [`unipile_linkedin_endorse_profile`](#unipile_linkedin_endorse_profile) | Endorse a user profile specific skill |
| [`unipile_linkedin_get_account_owner_profile`](#unipile_linkedin_get_account_owner_profile) | Retrieve own profile |
| [`unipile_linkedin_get_available_contracts`](#unipile_linkedin_get_available_contracts) | Retrieve contracts |
| [`unipile_linkedin_get_company_profile`](#unipile_linkedin_get_company_profile) | Retrieve a company profile |
| [`unipile_linkedin_get_followers`](#unipile_linkedin_get_followers) | List all followers |
| [`unipile_linkedin_get_following`](#unipile_linkedin_get_following) | List all followed accounts |
| [`unipile_linkedin_get_hiring_project_by_id`](#unipile_linkedin_get_hiring_project_by_id) | Retrieve Recruiter hiring project from ID |
| [`unipile_linkedin_get_hiring_projects`](#unipile_linkedin_get_hiring_projects) | Retrieve Recruiter hiring projects |
| [`unipile_linkedin_get_inmail_balance`](#unipile_linkedin_get_inmail_balance) | Get inmail credit balance |
| [`unipile_linkedin_get_job_applicant`](#unipile_linkedin_get_job_applicant) | Get a specific applicant to a job posting |
| [`unipile_linkedin_get_job_applicant_resume`](#unipile_linkedin_get_job_applicant_resume) | Download the resume of a job applicant |
| [`unipile_linkedin_get_job_applicants`](#unipile_linkedin_get_job_applicants) | List all applicants to a job posting |
| [`unipile_linkedin_get_job_posting`](#unipile_linkedin_get_job_posting) | Get job offer |
| [`unipile_linkedin_get_job_postings`](#unipile_linkedin_get_job_postings) | List all job postings |
| [`unipile_linkedin_get_post`](#unipile_linkedin_get_post) | Retrieve a post |
| [`unipile_linkedin_get_profile_by_identifier`](#unipile_linkedin_get_profile_by_identifier) | Retrieve a profile |
| [`unipile_linkedin_get_raw_data`](#unipile_linkedin_get_raw_data) | Get raw data from any endpoint |
| [`unipile_linkedin_get_relations`](#unipile_linkedin_get_relations) | List all relations |
| [`unipile_linkedin_get_search_parameters_list`](#unipile_linkedin_get_search_parameters_list) | Retrieve LinkedIn search parameters |
| [`unipile_linkedin_handle_invitation_received`](#unipile_linkedin_handle_invitation_received) | Handle a received invitation |
| [`unipile_linkedin_list_all_posts`](#unipile_linkedin_list_all_posts) | List all posts |
| [`unipile_linkedin_list_all_user_invitations_received`](#unipile_linkedin_list_all_user_invitations_received) | List all invitations received |
| [`unipile_linkedin_list_all_user_invitations_sent`](#unipile_linkedin_list_all_user_invitations_sent) | List all invitations sent |
| [`unipile_linkedin_list_post_comments`](#unipile_linkedin_list_post_comments) | List all comments from a post |
| [`unipile_linkedin_list_post_reactions`](#unipile_linkedin_list_post_reactions) | List all reactions from a post |
| [`unipile_linkedin_list_user_comments`](#unipile_linkedin_list_user_comments) | List all comments |
| [`unipile_linkedin_list_user_reactions`](#unipile_linkedin_list_user_reactions) | List all reactions |
| [`unipile_linkedin_perform_action_on_member`](#unipile_linkedin_perform_action_on_member) | Perform an action with a user profile |
| [`unipile_linkedin_publish_job_posting`](#unipile_linkedin_publish_job_posting) | Publish a job posting |
| [`unipile_linkedin_search`](#unipile_linkedin_search) | Perform Linkedin search |
| [`unipile_linkedin_select_contract`](#unipile_linkedin_select_contract) | Select contract |
| [`unipile_linkedin_send_comment`](#unipile_linkedin_send_comment) | Comment a post |
| [`unipile_linkedin_solve_job_checkpoint`](#unipile_linkedin_solve_job_checkpoint) | Solve a job publishing checkpoint |
***
## unipile\_linkedin\_add\_post\_reaction
Add a reaction to a post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `as_organization` | string | No | — | `Linkedin only` Provide the ID of an organization over which you have control to perform the action on its behalf. |
| `comment_id` | string | No | — | The id of the comment to send a reaction to. `Linkedin`: use the comment id returned by the comments list. |
| `post_id` | string | Yes | — | The id of the post to send a reaction to. \
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : [https://developer.unipile.com/docs/posts-and-comments](https://developer.unipile.com/docs/posts-and-comments) \
`Instagram` Please use the provider\_id |
| `reaction_type` | string | No | — | The type of reaction to send. If not provided, it defaults to 'like'. \
`Instagram`: The only supported reaction type is 'like'. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"as_organization": {
"type": "string",
"description": "`Linkedin only` Provide the ID of an organization over which you have control to perform the action on its behalf."
},
"comment_id": {
"type": "string",
"description": "The id of the comment to send a reaction to. `Linkedin`: use the comment id returned by the comments list."
},
"post_id": {
"type": "string",
"description": "The id of the post to send a reaction to.
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments
`Instagram` Please use the provider_id"
},
"reaction_type": {
"type": "string",
"description": "The type of reaction to send. If not provided, it defaults to 'like'.
`Instagram`: The only supported reaction type is 'like'.",
"enum": [
"like",
"celebrate",
"support",
"love",
"insightful",
"funny"
]
}
},
"required": [
"PCID",
"account_id",
"post_id"
]
}
```
***
## unipile\_linkedin\_add\_user\_by\_identifier
Send an invitation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `account_id` | string | Yes | — | The id of the account where the user will be added. |
| `message` | string | No | — | An optional message to go with the invitation (max 300 chars). |
| `provider_id` | string | Yes | — | The id of the user to add. It has to be the provider's id. \
`Instagram`: You can use the provider\_id or the username of the user. The provider\_messaging\_id dont work on this route ! |
| `user_email` | string | No | — | The email address of the user when it's required (Linkedin specific). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The id of the account where the user will be added."
},
"message": {
"type": "string",
"description": "An optional message to go with the invitation (max 300 chars)."
},
"provider_id": {
"type": "string",
"description": "The id of the user to add. It has to be the provider's id.
`Instagram`: You can use the provider_id or the username of the user. The provider_messaging_id dont work on this route !"
},
"user_email": {
"type": "string",
"description": "The email address of the user when it's required (Linkedin specific)."
}
},
"required": [
"PCID",
"account_id",
"provider_id"
]
}
```
***
## unipile\_linkedin\_cancel\_invitation
Cancel an invitation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `invitation_id` | string | Yes | — | The id of the invitation to cancel. \
`Instagram`: Use the 'provider\_id' retrieved in user profile (not 'provider\_messaging\_id') |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"invitation_id": {
"type": "string",
"description": "The id of the invitation to cancel.
`Instagram`: Use the 'provider_id' retrieved in user profile (not 'provider_messaging_id')"
}
},
"required": [
"PCID",
"account_id",
"invitation_id"
]
}
```
***
## unipile\_linkedin\_close\_job\_posting
Close a job posting
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `id` | string | Yes | — | The ID of the job offer. |
| `service` | string | No | — | The Linkedin service the job posting depends on. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the job offer."
},
"service": {
"type": "string",
"description": "The Linkedin service the job posting depends on.",
"enum": [
"CLASSIC",
"RECRUITER"
]
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"id",
"account_id"
]
}
```
***
## unipile\_linkedin\_create\_job\_posting
Create a job posting
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `account_id` | string | Yes | — | An Unipile account id. |
| `auto_rejection_template` | string | No | — | You can define a rejection message template to be automatically sent to applicants that don't pass screening questions. |
| `company` | object | Yes | — | The company value |
| `description` | string | Yes | — | You can use HTML tags to structure your description. |
| `employment_status` | string | No | — | Employment Status |
| `job_title` | object | Yes | — | Job Title |
| `location` | string | Yes | — | The ID of the parameter. Use type LOCATION on the List search parameters route to find out the right ID. |
| `recruiter` | object | No | — | The recruiter value |
| `screening_questions` | any\[] | No | — | Screening Questions |
| `workplace` | string | Yes | — | The workplace value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "An Unipile account id."
},
"auto_rejection_template": {
"type": "string",
"description": "You can define a rejection message template to be automatically sent to applicants that don't pass screening questions."
},
"company": {
"type": "object",
"description": "The company value",
"properties": {
"id": {
"type": "string",
"description": "The ID of the parameter. Use type COMPANY on the List search parameters route to find out the right ID."
},
"text": {
"type": "string",
"description": "The text value"
}
}
},
"description": {
"type": "string",
"description": "You can use HTML tags to structure your description."
},
"employment_status": {
"type": "string",
"description": "Employment Status",
"enum": [
"FULL_TIME",
"PART_TIME",
"CONTRACT",
"TEMPORARY",
"OTHER",
"VOLUNTEER",
"INTERNSHIP"
]
},
"job_title": {
"type": "object",
"description": "Job Title",
"properties": {
"id": {
"type": "string",
"description": "The ID of the parameter. Use type JOB_TITLE on the List search parameters route to find out the right ID."
},
"text": {
"type": "string",
"description": "The text value"
}
}
},
"location": {
"type": "string",
"description": "The ID of the parameter. Use type LOCATION on the List search parameters route to find out the right ID."
},
"recruiter": {
"type": "object",
"description": "The recruiter value",
"properties": {
"project": {
"description": "The project value"
},
"functions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the parameter. Use type JOB_FUNCTION on the List search parameters route to find out the right ID. Linkedin native field : Job function."
},
"industries": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the parameter. Use type INDUSTRY on the List search parameters route to find out the right ID. Linkedin native field : Company industry."
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the parameter. Use type SKILL on the List search parameters route to find out the right ID. Linkedin native field : Skills."
},
"seniority": {
"type": "string",
"description": "The seniority value",
"enum": [
"INTERNSHIP",
"ENTRY_LEVEL",
"ASSOCIATE",
"MID_SENIOR_LEVEL",
"DIRECTOR",
"EXECUTIVE",
"NOT_APPLICABLE"
]
},
"include_poster_info": {
"type": "boolean",
"description": "Show profile on the job post."
},
"tracking_pixel_url": {
"type": "string",
"description": "Enter a URL for impression tracking"
},
"company_job_id": {
"type": "string",
"description": "Employer job ID for impression tracking"
},
"apply_method": {
"description": "Apply Method"
},
"salary": {
"type": "object",
"description": "The salary value"
},
"additional_compensation": {
"type": "object",
"description": "Additional Compensation"
},
"auto_archive_applicants": {
"type": "object",
"description": "Linkedin native field : Qualification setting."
},
"send_rejection_notification": {
"type": "boolean",
"description": "Linkedin native field : Send rejection notification."
}
},
"required": [
"project",
"functions",
"industries",
"seniority",
"apply_method"
]
},
"screening_questions": {
"type": "array",
"description": "Screening Questions"
},
"workplace": {
"type": "string",
"description": "The workplace value",
"enum": [
"ON_SITE",
"HYBRID",
"REMOTE"
]
}
},
"required": [
"PCID",
"account_id",
"company",
"description",
"job_title",
"location",
"workplace"
]
}
```
***
## unipile\_linkedin\_create\_post
Create a post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `as_organization` | string | No | — | `Linkedin only` Provide the ID of an organization over which you have control to perform the action on its behalf. |
| `attachments` | string\[] | No | — | On `linkedin`, image file resolution is limited to 6012px x 6012px max. |
| `external_link` | string | No | — | `Linkedin only` An external link that should be displayed within a preview card. The URL must also be included in the post textual content. Otherwise, it will be automatically added at the end. |
| `include_job_posting` | string | No | — | `Linkedin only` The ID of a job posting that should be displayed within a preview card. |
| `location` | string | No | — | `Instagram only`: The location to tag in the post. |
| `mentions` | object\[] | No | — | `Linkedin only` |
| `repost` | string | No | — | The id of an existing LinkedIn post to publish as repost. For a simple repost without commentary, `text` should be an empty string. |
| `text` | string | Yes | — | `Linkedin`: You can add a mention by inserting the index of the corresponding entry from the mentions array between two double braces. Example: Hey \{\{0}}, check this out ! \
`Instagram`: To mention a user, use the @ symbol followed by their username. |
| `video_thumbnail` | string | No | — | Video Thumbnail |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"as_organization": {
"type": "string",
"description": "`Linkedin only` Provide the ID of an organization over which you have control to perform the action on its behalf."
},
"attachments": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "On `linkedin`, image file resolution is limited to 6012px x 6012px max."
},
"external_link": {
"type": "string",
"description": "`Linkedin only` An external link that should be displayed within a preview card. The URL must also be included in the post textual content. Otherwise, it will be automatically added at the end."
},
"include_job_posting": {
"type": "string",
"description": "`Linkedin only` The ID of a job posting that should be displayed within a preview card."
},
"location": {
"type": "string",
"description": "`Instagram only`: The location to tag in the post."
},
"mentions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the user as it will be displayed in your message."
},
"profile_id": {
"type": "string",
"description": "The provider ID of the user, which begins with ACo/ADo for individuals and is a series of digits for companies."
},
"is_company": {
"type": "boolean",
"description": "Is Company"
}
},
"required": [
"name",
"profile_id"
]
},
"description": "`Linkedin only`"
},
"repost": {
"type": "string",
"description": "The id of an existing LinkedIn post to publish as repost. For a simple repost without commentary, `text` should be an empty string."
},
"text": {
"type": "string",
"description": "`Linkedin`: You can add a mention by inserting the index of the corresponding entry from the mentions array between two double braces. Example: Hey {{0}}, check this out !
`Instagram`: To mention a user, use the @ symbol followed by their username."
},
"video_thumbnail": {
"type": "string",
"description": "Video Thumbnail"
}
},
"required": [
"PCID",
"account_id",
"text"
]
}
```
***
## unipile\_linkedin\_edit\_account\_owner\_profile
Edit own profile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | -------------------------------------- |
| `account_id` | string | Yes | — | An Unipile account id. |
| `cover_picture` | string | No | — | Cover Picture |
| `cover_picture_settings` | object | No | — | Cover Picture Settings |
| `custom_link` | object | No | — | Custom Link |
| `education` | object | No | — | Add or edit an education. |
| `experience` | object | No | — | Add or edit a professional experience. |
| `headline` | string | No | — | The subtitle of your profile. |
| `location` | object | No | — | The location value |
| `open_to_work` | object | No | — | Open To Work |
| `picture` | string | No | — | The picture value |
| `picture_settings` | object | No | — | Picture Settings |
| `skills` | string\[] | No | — | The skills value |
| `skills_follow` | boolean | No | — | Skills Follow |
| `summary` | string | No | — | The ABOUT section of your profile. |
| `type` | string | No | — | The type value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "An Unipile account id."
},
"cover_picture": {
"type": "string",
"description": "Cover Picture"
},
"cover_picture_settings": {
"type": "object",
"description": "Cover Picture Settings",
"properties": {
"filter": {
"type": "string",
"description": "The filter value",
"enum": [
"ORIGINAL",
"STUDIO",
"SPOTLIGHT",
"PRIME",
"CLASSIC",
"EDGE",
"LUMINATE"
]
},
"layout": {
"type": "object",
"description": "The layout value"
},
"contrast": {
"type": "number",
"description": "The contrast value"
},
"vignette": {
"type": "number",
"description": "The vignette value"
},
"saturation": {
"type": "number",
"description": "The saturation value"
},
"brightness": {
"type": "number",
"description": "The brightness value"
}
}
},
"custom_link": {
"type": "object",
"description": "Custom Link",
"properties": {
"type": {
"type": "string",
"description": "The type value",
"enum": [
"STORE",
"WEBSITE",
"PORTFOLIO",
"BLOG",
"NEWSLETTER"
]
},
"url": {
"type": "string",
"description": "The url value"
},
"display_on": {
"type": "string",
"description": "Display On",
"enum": [
"PROFILE_ONLY",
"EVERYWHERE"
]
}
},
"required": [
"type",
"url"
]
},
"education": {
"description": "Add or edit an education."
},
"experience": {
"description": "Add or edit a professional experience."
},
"headline": {
"type": "string",
"description": "The subtitle of your profile."
},
"location": {
"type": "object",
"description": "The location value",
"properties": {
"id": {
"type": "string",
"description": "The ID of the location. Use the Retrieve LinkedIn search parameters route with type LOCATION to find the right one : https://developer.unipile.com/reference/linkedincontroller_getsearchparameterslist"
},
"postal_code": {
"type": "string",
"description": "A 5 digits postal code."
}
},
"required": [
"id"
]
},
"open_to_work": {
"type": "object",
"description": "Open To Work",
"properties": {
"job_title": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of Job titles."
},
"presence": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ON_SITE",
"HYBRID",
"REMOTE"
]
},
"description": "The presence value"
},
"location": {
"type": "object",
"description": "The location value"
},
"start_date": {
"type": "string",
"description": "Start date for filtering",
"enum": [
"IMMEDIATELY",
"FLEXIBLE"
]
},
"employment_type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"FULL_TIME",
"PART_TIME",
"CONTRACT",
"INTERNSHIP",
"TEMPORARY"
]
},
"description": "Employment Type"
},
"visibility": {
"type": "string",
"description": "The visibility value",
"enum": [
"ALL",
"RECRUITERS_ONLY"
]
}
},
"required": [
"job_title",
"presence",
"location"
]
},
"picture": {
"type": "string",
"description": "The picture value"
},
"picture_settings": {
"type": "object",
"description": "Picture Settings",
"properties": {
"filter": {
"type": "string",
"description": "The filter value",
"enum": [
"ORIGINAL",
"STUDIO",
"SPOTLIGHT",
"PRIME",
"CLASSIC",
"EDGE",
"LUMINATE"
]
},
"layout": {
"type": "object",
"description": "The layout value"
},
"contrast": {
"type": "number",
"description": "The contrast value"
},
"vignette": {
"type": "number",
"description": "The vignette value"
},
"saturation": {
"type": "number",
"description": "The saturation value"
},
"brightness": {
"type": "number",
"description": "The brightness value"
}
}
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"description": "The skills value"
},
"skills_follow": {
"type": "boolean",
"description": "Skills Follow"
},
"summary": {
"type": "string",
"description": "The ABOUT section of your profile."
},
"type": {
"type": "string",
"description": "The type value",
"enum": [
"LINKEDIN"
]
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_edit\_job\_posting
Edit a job posting
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `job_id` | string | Yes | — | The id of the job to edit. |
| `account_id` | string | No | — | An Unipile account id. |
| `auto_rejection_template` | string | No | — | You can define a rejection message template to be automatically sent to applicants that don't pass screening questions. |
| `company` | object | No | — | The company value |
| `description` | string | No | — | You can use HTML tags to structure your description. |
| `employment_status` | string | No | — | Employment Status |
| `job_title` | object | No | — | Job Title |
| `location` | string | No | — | The ID of the parameter. Use type LOCATION on the List search parameters route to find out the right ID. |
| `recruiter` | object | No | — | The recruiter value |
| `screening_questions` | any\[] | No | — | Screening Questions |
| `workplace` | string | No | — | The workplace value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"job_id": {
"type": "string",
"description": "The id of the job to edit."
},
"account_id": {
"type": "string",
"description": "An Unipile account id."
},
"auto_rejection_template": {
"type": "string",
"description": "You can define a rejection message template to be automatically sent to applicants that don't pass screening questions."
},
"company": {
"type": "object",
"description": "The company value",
"properties": {
"id": {
"type": "string",
"description": "The ID of the parameter. Use type COMPANY on the List search parameters route to find out the right ID."
},
"text": {
"type": "string",
"description": "The text value"
}
}
},
"description": {
"type": "string",
"description": "You can use HTML tags to structure your description."
},
"employment_status": {
"type": "string",
"description": "Employment Status",
"enum": [
"FULL_TIME",
"PART_TIME",
"CONTRACT",
"TEMPORARY",
"OTHER",
"VOLUNTEER",
"INTERNSHIP"
]
},
"job_title": {
"type": "object",
"description": "Job Title",
"properties": {
"id": {
"type": "string",
"description": "The ID of the parameter. Use type JOB_TITLE on the List search parameters route to find out the right ID."
},
"text": {
"type": "string",
"description": "The text value"
}
}
},
"location": {
"type": "string",
"description": "The ID of the parameter. Use type LOCATION on the List search parameters route to find out the right ID."
},
"recruiter": {
"type": "object",
"description": "The recruiter value",
"properties": {
"functions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the parameter. Use type JOB_FUNCTION on the List search parameters route to find out the right ID. Linkedin native field : Job function."
},
"industries": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the parameter. Use type INDUSTRY on the List search parameters route to find out the right ID. Linkedin native field : Company industry."
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the parameter. Use type SKILL on the List search parameters route to find out the right ID. Linkedin native field : Skills."
},
"seniority": {
"type": "string",
"description": "The seniority value",
"enum": [
"INTERNSHIP",
"ENTRY_LEVEL",
"ASSOCIATE",
"MID_SENIOR_LEVEL",
"DIRECTOR",
"EXECUTIVE",
"NOT_APPLICABLE"
]
},
"include_poster_info": {
"type": "boolean",
"description": "Show profile on the job post."
},
"tracking_pixel_url": {
"type": "string",
"description": "Enter a URL for impression tracking"
},
"company_job_id": {
"type": "string",
"description": "Employer job ID for impression tracking"
},
"apply_method": {
"description": "Apply Method"
},
"salary": {
"type": "object",
"description": "The salary value"
},
"additional_compensation": {
"type": "object",
"description": "Additional Compensation"
},
"auto_archive_applicants": {
"type": "object",
"description": "Linkedin native field : Qualification setting."
},
"send_rejection_notification": {
"type": "boolean",
"description": "Linkedin native field : Send rejection notification."
},
"project_id": {
"type": "string",
"description": "The ID of the project the offer is linked to."
}
},
"required": [
"project_id"
]
},
"screening_questions": {
"type": "array",
"description": "Screening Questions"
},
"workplace": {
"type": "string",
"description": "The workplace value",
"enum": [
"ON_SITE",
"HYBRID",
"REMOTE"
]
}
},
"required": [
"PCID",
"job_id"
]
}
```
***
## unipile\_linkedin\_endorse\_profile
Endorse a user profile specific skill
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | string | Yes | — | An Unipile account id. |
| `profile_id` | string | Yes | — | The provider ID of the user, starting with ACo/ADo. |
| `skill_endorsement_id` | number | Yes | — | This is the endorsement\_id that can be found along with the skill details on the result of the Retrieve a profile route : [https://developer.unipile.com/reference/userscontroller\_getprofilebyidentifier](https://developer.unipile.com/reference/userscontroller_getprofilebyidentifier) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "An Unipile account id."
},
"profile_id": {
"type": "string",
"description": "The provider ID of the user, starting with ACo/ADo."
},
"skill_endorsement_id": {
"type": "number",
"description": "This is the endorsement_id that can be found along with the skill details on the result of the Retrieve a profile route : https://developer.unipile.com/reference/userscontroller_getprofilebyidentifier"
}
},
"required": [
"PCID",
"account_id",
"profile_id",
"skill_endorsement_id"
]
}
```
***
## unipile\_linkedin\_get\_account\_owner\_profile
Retrieve own profile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_available\_contracts
Retrieve contracts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_company\_profile
Retrieve a company profile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------- |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
| `identifier` | string | Yes | — | The identifier of the company: either the public identifier, the ID or the URN. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
},
"identifier": {
"type": "string",
"description": "The identifier of the company: either the public identifier, the ID or the URN."
}
},
"required": [
"PCID",
"account_id",
"identifier"
]
}
```
***
## unipile\_linkedin\_get\_followers
List all followers
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | string | No | — | `Instagram` The user to get the followers from (provider\_id or username).\
`Linkedin` The user or company to get the followers from (provider\_id only). |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response.\
`Linkedin` maximum 100\
`Instagram` maximum 200 |
| `account_id` | string | Yes | — | The account to get the followers from. (if user\_id is not provided) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "`Instagram` The user to get the followers from (provider_id or username).
`Linkedin` The user or company to get the followers from (provider_id only)."
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response.
`Linkedin` maximum 100
`Instagram` maximum 200"
},
"account_id": {
"type": "string",
"description": "The account to get the followers from. (if user_id is not provided)"
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_following
List all followed accounts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | string | No | — | `Instagram only` The user to get the followed accounts from (provider\_id or username). |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 1000. |
| `account_id` | string | Yes | — | The account to get the followed accounts from. (if user\_id is not provided) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "`Instagram only` The user to get the followed accounts from (provider_id or username)."
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 1000."
},
"account_id": {
"type": "string",
"description": "The account to get the followed accounts from. (if user_id is not provided)"
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_hiring\_project\_by\_id
Retrieve Recruiter hiring project from ID
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
| `id` | string | Yes | — | The ID of the hiring project. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
},
"id": {
"type": "string",
"description": "The ID of the hiring project."
}
},
"required": [
"PCID",
"account_id",
"id"
]
}
```
***
## unipile\_linkedin\_get\_hiring\_projects
Retrieve Recruiter hiring projects
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `sort_order` | string | No | — | The sorting order for the hiring projects. Default is DESCENDING. |
| `sort_by` | string | No | — | The sorting method for the hiring projects. Default is ACCESSED\_TIME. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"sort_order": {
"type": "string",
"description": "The sorting order for the hiring projects. Default is DESCENDING.",
"enum": [
"ASCENDING",
"DESCENDING"
]
},
"sort_by": {
"type": "string",
"description": "The sorting method for the hiring projects. Default is ACCESSED_TIME.",
"enum": [
"NAME",
"FAVORITE",
"CREATED_TIME",
"ACCESSED_TIME",
"ENGAGED_TIME",
"ENGAGEMENT_COUNT"
]
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_inmail\_balance
Get inmail credit balance
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_job\_applicant
Get a specific applicant to a job posting
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------------------------- |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
| `applicant_id` | string | Yes | — | The ID of the applicant. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
},
"applicant_id": {
"type": "string",
"description": "The ID of the applicant."
}
},
"required": [
"PCID",
"account_id",
"applicant_id"
]
}
```
***
## unipile\_linkedin\_get\_job\_applicant\_resume
Download the resume of a job applicant
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------ |
| `service` | string | No | — | The Linkedin service the applicant depends on. Default is classic. |
| `applicant_id` | string | Yes | — | The ID of the job applicant. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"service": {
"type": "string",
"description": "The Linkedin service the applicant depends on. Default is classic.",
"enum": [
"CLASSIC",
"RECRUITER"
]
},
"applicant_id": {
"type": "string",
"description": "The ID of the job applicant."
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"applicant_id",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_job\_applicants
List all applicants to a job posting
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `max_years_in_company` | number | No | — | Linkedin Recruiter native filter : YEARS IN CURRENT COMPANY. |
| `min_years_in_company` | number | No | — | Linkedin Recruiter native filter : YEARS IN CURRENT COMPANY. |
| `max_years_in_position` | number | No | — | Linkedin Recruiter native filter : YEARS IN CURRENT POSITION. |
| `min_years_in_position` | number | No | — | Linkedin Recruiter native filter : YEARS IN CURRENT POSITION. |
| `max_years_of_experience` | number | No | — | Linkedin Recruiter native filter : YEARS OF EXPERIENCE. |
| `min_years_of_experience` | number | No | — | Linkedin Recruiter native filter : YEARS OF EXPERIENCE. |
| `exclude_degree` | string\[] | No | — | Linkedin Recruiter native filter : DEGREES (excluded). |
| `include_degree` | string\[] | No | — | Linkedin Recruiter native filter : DEGREES (included). |
| `ratings` | string | No | — | One or more ratings (UNRATED, GOOD\_FIT, MAYBE, NOT\_A\_FIT) separated by commas. |
| `keywords` | string | No | — | Filter results with keywords. |
| `sort_by` | string | No | — | The sorting rule for applicants. Recruiter only. |
| `service` | string | No | — | The Linkedin service the job posting depends on. Default is classic. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
| `id` | string | Yes | — | The ID of the job offer. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"max_years_in_company": {
"type": "number",
"description": "Linkedin Recruiter native filter : YEARS IN CURRENT COMPANY."
},
"min_years_in_company": {
"type": "number",
"description": "Linkedin Recruiter native filter : YEARS IN CURRENT COMPANY."
},
"max_years_in_position": {
"type": "number",
"description": "Linkedin Recruiter native filter : YEARS IN CURRENT POSITION."
},
"min_years_in_position": {
"type": "number",
"description": "Linkedin Recruiter native filter : YEARS IN CURRENT POSITION."
},
"max_years_of_experience": {
"type": "number",
"description": "Linkedin Recruiter native filter : YEARS OF EXPERIENCE."
},
"min_years_of_experience": {
"type": "number",
"description": "Linkedin Recruiter native filter : YEARS OF EXPERIENCE."
},
"exclude_degree": {
"type": "array",
"items": {
"type": "string"
},
"description": "Linkedin Recruiter native filter : DEGREES (excluded)."
},
"include_degree": {
"type": "array",
"items": {
"type": "string"
},
"description": "Linkedin Recruiter native filter : DEGREES (included)."
},
"ratings": {
"type": "string",
"description": "One or more ratings (UNRATED, GOOD_FIT, MAYBE, NOT_A_FIT) separated by commas."
},
"keywords": {
"type": "string",
"description": "Filter results with keywords."
},
"sort_by": {
"type": "string",
"description": "The sorting rule for applicants. Recruiter only.",
"enum": [
"relevance",
"alphabetical",
"newest_first",
"screening_requirements"
]
},
"service": {
"type": "string",
"description": "The Linkedin service the job posting depends on. Default is classic.",
"enum": [
"CLASSIC",
"RECRUITER"
]
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
},
"id": {
"type": "string",
"description": "The ID of the job offer."
}
},
"required": [
"PCID",
"account_id",
"id"
]
}
```
***
## unipile\_linkedin\_get\_job\_posting
Get job offer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `job_id` | string | Yes | — | The ID of the job offer. |
| `service` | string | Yes | — | The Linkedin service the job posting depends on. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"job_id": {
"type": "string",
"description": "The ID of the job offer."
},
"service": {
"type": "string",
"description": "The Linkedin service the job posting depends on.",
"enum": [
"CLASSIC",
"RECRUITER"
]
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"job_id",
"service",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_job\_postings
List all job postings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. |
| `category` | string | No | — | The state of the requested job postings. Default is active. |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
},
"category": {
"type": "string",
"description": "The state of the requested job postings. Default is active.",
"enum": [
"active",
"draft",
"closed"
]
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_post
Retrieve a post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `post_id` | string | Yes | — | The id of the post. \
`Linkedin`: if the URL contains **activity**, use the numeric id (example: ...-activity-7332661864792854528-... => `7332661864792854528`). \
If the URL contains **ugcPost**, use `urn:li:ugcPost:ID`. \
If the URL contains **share**, use `urn:li:share:ID`. \
`Instagram`: You can use the **provider\_id** or the **shortcode** found in the post URL. (***[www.instagram.com/reel/SHORTCODE](http://www.instagram.com/reel/SHORTCODE)***) |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"post_id": {
"type": "string",
"description": "The id of the post.
`Linkedin`: if the URL contains **activity**, use the numeric id (example: ...-activity-7332661864792854528-... => `7332661864792854528`).
If the URL contains **ugcPost**, use `urn:li:ugcPost:ID`.
If the URL contains **share**, use `urn:li:share:ID`.
`Instagram`: You can use the **provider_id** or the **shortcode** found in the post URL. (***www.instagram.com/reel/SHORTCODE***)"
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
}
},
"required": [
"PCID",
"post_id",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_profile\_by\_identifier
Retrieve a profile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `linkedin_sections` | string\[] | No | — | A list of profile sections to retrieve detailed information on a LinkedIn profile. LinkedIn may throttle heavy use of full data section requests, so pick only the sections you truly need. Select \*\_preview to fetch all sections with preview data (first entries as displayed in the LinkedIn profile UI), or \* to fetch all sections with full data (not recommended if you're chaining a lot of profile calls in a short period). You can also combine selectors, for example, `["*_preview", "experience", "skills"]` to get all sections in preview plus experience and skills in full. In the response, you may receive empty sections if LinkedIn is throttling your requests. In such case, the `throttled_sections` field lists the concerned sections. To prevent this, you should add random delay between your calls, and/or not request as many sections as you use to. |
| `linkedin_api` | string | No | — | The LinkedIn API that should be used to get the profile (relative features must be subscribed), if different from classic. |
| `notify` | boolean | No | — | Whether the profile visit should be notified to the viewee or not. Default is false. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `identifier` | string | Yes | — | Can be the provider's internal id OR the provider's public id of the requested user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"linkedin_sections": {
"type": "array",
"items": {
"type": "string",
"enum": [
"*",
"*_preview",
"about",
"experience",
"education",
"languages",
"skills",
"certifications",
"volunteering_experience",
"projects",
"recommendations_received",
"recommendations_given",
"recruiting_activity",
"experience_preview",
"education_preview",
"languages_preview",
"skills_preview",
"certifications_preview",
"volunteering_experience_preview",
"projects_preview",
"recommendations_received_preview",
"recommendations_given_preview"
]
},
"description": "A list of profile sections to retrieve detailed information on a LinkedIn profile. LinkedIn may throttle heavy use of full data section requests, so pick only the sections you truly need. Select *_preview to fetch all sections with preview data (first entries as displayed in the LinkedIn profile UI), or * to fetch all sections with full data (not recommended if you're chaining a lot of profile calls in a short period). You can also combine selectors, for example, `[\"*_preview\", \"experience\", \"skills\"]` to get all sections in preview plus experience and skills in full. In the response, you may receive empty sections if LinkedIn is throttling your requests. In such case, the `throttled_sections` field lists the concerned sections. To prevent this, you should add random delay between your calls, and/or not request as many sections as you use to."
},
"linkedin_api": {
"type": "string",
"description": "The LinkedIn API that should be used to get the profile (relative features must be subscribed), if different from classic.",
"enum": [
"recruiter",
"sales_navigator"
]
},
"notify": {
"type": "boolean",
"description": "Whether the profile visit should be notified to the viewee or not. Default is false."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"identifier": {
"type": "string",
"description": "Can be the provider's internal id OR the provider's public id of the requested user."
}
},
"required": [
"PCID",
"account_id",
"identifier"
]
}
```
***
## unipile\_linkedin\_get\_raw\_data
Get raw data from any endpoint
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `account_id` | string | Yes | — | A unique identifier. |
| `body` | object | No | — | A body object to be passed for POST requests. |
| `bypass_redirect` | boolean | No | — | If true, do not follow HTTP redirects automatically. |
| `encoding` | boolean | No | — | Whether the query params or the body (in case of x-www-form-urlencoded content) should be encoded on the go. |
| `force_api` | boolean | No | — | Set to true if you need to use an API for which you might not have an active subscription. |
| `headers` | object | No | — | A headers object to be added to requests if needed. |
| `method` | string | No | — | The method to be used for the request to be performed. Default is GET. |
| `query_params` | object | No | — | A query parameters object. |
| `request_url` | string | Yes | — | An url pointing to some Linkedin API feature |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "A unique identifier."
},
"body": {
"type": "object",
"description": "A body object to be passed for POST requests."
},
"bypass_redirect": {
"type": "boolean",
"description": "If true, do not follow HTTP redirects automatically."
},
"encoding": {
"type": "boolean",
"description": "Whether the query params or the body (in case of x-www-form-urlencoded content) should be encoded on the go."
},
"force_api": {
"type": "boolean",
"description": "Set to true if you need to use an API for which you might not have an active subscription."
},
"headers": {
"type": "object",
"description": "A headers object to be added to requests if needed."
},
"method": {
"type": "string",
"description": "The method to be used for the request to be performed. Default is GET.",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"query_params": {
"type": "object",
"description": "A query parameters object."
},
"request_url": {
"type": "string",
"description": "An url pointing to some Linkedin API feature"
}
},
"required": [
"PCID",
"account_id",
"request_url"
]
}
```
***
## unipile\_linkedin\_get\_relations
List all relations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `filter` | string | No | — | Filter out results by user name. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 1000. |
| `account_id` | string | Yes | — | The account to get the relations from. (if user\_id is not provided) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"filter": {
"type": "string",
"description": "Filter out results by user name."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 1000."
},
"account_id": {
"type": "string",
"description": "The account to get the relations from. (if user_id is not provided)"
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_get\_search\_parameters\_list
Retrieve LinkedIn search parameters
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `keywords` | string | No | — | The keywords to start the search from. Not applicable to the following parameters : EMPLOYMENT\_TYPE. |
| `service` | string | No | — | Select the LinkedIn API to be used to query common parameters. Default is CLASSIC. |
| `type` | object | Yes | — | The type of parameter for the requested search. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"keywords": {
"type": "string",
"description": "The keywords to start the search from. Not applicable to the following parameters : EMPLOYMENT_TYPE."
},
"service": {
"type": "string",
"description": "Select the LinkedIn API to be used to query common parameters. Default is CLASSIC.",
"enum": [
"CLASSIC",
"RECRUITER",
"SALES_NAVIGATOR"
]
},
"type": {
"description": "The type of parameter for the requested search."
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"type",
"account_id"
]
}
```
***
## unipile\_linkedin\_handle\_invitation\_received
Handle a received invitation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------ |
| `invitation_id` | string | Yes | — | The invitation ID. |
| `body` | object | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invitation_id": {
"type": "string",
"description": "The invitation ID."
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"invitation_id",
"body"
]
}
```
***
## unipile\_linkedin\_list\_all\_posts
List all posts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `is_company` | boolean | No | — | `Linkedin only` Set it to **"true"** if the posts are from a company. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `identifier` | string | Yes | — | The entity's provider internal id. \
`Linkedin`: starts with ACo/ADo for users, while for companies it's a series of numbers. \
`Instagram`: use the provider\_id or the username of the user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"is_company": {
"type": "boolean",
"description": "`Linkedin only` Set it to **\"true\"** if the posts are from a company."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"identifier": {
"type": "string",
"description": "The entity's provider internal id.
`Linkedin`: starts with ACo/ADo for users, while for companies it's a series of numbers.
`Instagram`: use the provider_id or the username of the user."
}
},
"required": [
"PCID",
"account_id",
"identifier"
]
}
```
***
## unipile\_linkedin\_list\_all\_user\_invitations\_received
List all invitations received
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_list\_all\_user\_invitations\_sent
List all invitations sent
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 250."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## unipile\_linkedin\_list\_post\_comments
List all comments from a post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `sort_by` | string | No | — | The sort method for the post comments. Default is MOST\_RECENT. |
| `comment_id` | string | No | — | The id of the comment to get replies from. \
`Linkedin`: use the comment `id` returned by the comments list. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `post_id` | string | Yes | — | The ID of the associated post. \
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : [https://developer.unipile.com/docs/posts-and-comments](https://developer.unipile.com/docs/posts-and-comments) \
`Instagram`: Need to use the **provider\_id**. Short code cannot be used here (***[www.instagram.com/p/SHORTCODE](http://www.instagram.com/p/SHORTCODE)***) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"sort_by": {
"type": "string",
"description": "The sort method for the post comments. Default is MOST_RECENT.",
"enum": [
"MOST_RECENT",
"MOST_RELEVANT"
]
},
"comment_id": {
"type": "string",
"description": "The id of the comment to get replies from.
`Linkedin`: use the comment `id` returned by the comments list."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"post_id": {
"type": "string",
"description": "The ID of the associated post.
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments
`Instagram`: Need to use the **provider_id**. Short code cannot be used here (***www.instagram.com/p/SHORTCODE***)"
}
},
"required": [
"PCID",
"account_id",
"post_id"
]
}
```
***
## unipile\_linkedin\_list\_post\_reactions
List all reactions from a post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `comment_id` | string | No | — | The id of the comment to get reactions from. \
`Linkedin`: use the comment `id` returned by the comments list. |
| `account_id` | string | No | — | The id of the account to perform the request from. |
| `post_id` | string | Yes | — | The ID of the associated post. \
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : [https://developer.unipile.com/docs/posts-and-comments](https://developer.unipile.com/docs/posts-and-comments) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"comment_id": {
"type": "string",
"description": "The id of the comment to get reactions from.
`Linkedin`: use the comment `id` returned by the comments list."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"post_id": {
"type": "string",
"description": "The ID of the associated post.
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments"
}
},
"required": [
"PCID",
"post_id"
]
}
```
***
## unipile\_linkedin\_list\_user\_comments
List all comments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `identifier` | string | Yes | — | The user's provider internal id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"identifier": {
"type": "string",
"description": "The user's provider internal id."
}
},
"required": [
"PCID",
"account_id",
"identifier"
]
}
```
***
## unipile\_linkedin\_list\_user\_reactions
List all reactions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 100. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `identifier` | string | Yes | — | The user's provider internal id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. The value can be set between 1 and 100."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"identifier": {
"type": "string",
"description": "The user's provider internal id."
}
},
"required": [
"PCID",
"account_id",
"identifier"
]
}
```
***
## unipile\_linkedin\_perform\_action\_on\_member
Perform an action with a user profile
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `user_id` | string | Yes | — | The ID of the user. |
| `body` | object | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "The ID of the user."
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"user_id",
"body"
]
}
```
***
## unipile\_linkedin\_publish\_job\_posting
Publish a job posting
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------- |
| `draft_id` | string | Yes | — | The id of the draft to publish. |
| `body` | object | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"draft_id": {
"type": "string",
"description": "The id of the draft to publish."
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"draft_id",
"body"
]
}
```
***
## unipile\_linkedin\_search
Perform Linkedin search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. |
| `limit` | integer | No | — | A limit for the number of items returned in the response. Can bet set up to 100 results for Sales Navigator and Recruiter, but Linkedin Classic shouldn't exceed 50. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
| `body` | object | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved."
},
"limit": {
"type": "integer",
"description": "A limit for the number of items returned in the response. Can bet set up to 100 results for Sales Navigator and Recruiter, but Linkedin Classic shouldn't exceed 50."
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"account_id",
"body"
]
}
```
***
## unipile\_linkedin\_select\_contract
Select contract
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `id` | string | Yes | — | The ID of the contract. |
| `account_id` | string | Yes | — | The ID of the account to trigger the request from. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the contract."
},
"account_id": {
"type": "string",
"description": "The ID of the account to trigger the request from."
}
},
"required": [
"PCID",
"id",
"account_id"
]
}
```
***
## unipile\_linkedin\_send\_comment
Comment a post
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `post_id` | string | Yes | — | The ID of the associated post. \
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : [https://developer.unipile.com/docs/posts-and-comments](https://developer.unipile.com/docs/posts-and-comments) \
`Instagram` Post short code dont work on this route, please use the provider\_id instead. |
| `account_id` | string | Yes | — | The id of the account to perform the request from. |
| `as_organization` | string | No | — | `Linkedin only` Provide the ID of an organization over which you have control to perform the action on its behalf. |
| `attachments` | string\[] | No | — | On `linkedin`, only one image file is accepted with a resolution limited to 6012px x 6012px max. |
| `comment_id` | string | No | — | The id of the comment to reply to. `Linkedin`: use the comment id returned by the comments list. |
| `external_link` | string | No | — | `Linkedin only` An external link that should be displayed within a preview card. The URL must also be included in the post textual content. Otherwise, it will be automatically added at the end. |
| `mentions` | object\[] | No | — | `Linkedin only` |
| `text` | string | Yes | — | `Linkedin`: You can add a mention by inserting the index of the corresponding entry from the mentions array between two double braces. Example: Hey \{\{0}}, check this out ! \
`Instagram`: You can mention users by inserting their username in the text, like @username. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"post_id": {
"type": "string",
"description": "The ID of the associated post.
`Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments
`Instagram` Post short code dont work on this route, please use the provider_id instead."
},
"account_id": {
"type": "string",
"description": "The id of the account to perform the request from."
},
"as_organization": {
"type": "string",
"description": "`Linkedin only` Provide the ID of an organization over which you have control to perform the action on its behalf."
},
"attachments": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "On `linkedin`, only one image file is accepted with a resolution limited to 6012px x 6012px max."
},
"comment_id": {
"type": "string",
"description": "The id of the comment to reply to. `Linkedin`: use the comment id returned by the comments list."
},
"external_link": {
"type": "string",
"description": "`Linkedin only` An external link that should be displayed within a preview card. The URL must also be included in the post textual content. Otherwise, it will be automatically added at the end."
},
"mentions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the user as it will be displayed in your message."
},
"profile_id": {
"type": "string",
"description": "The provider ID of the user, which begins with ACo/ADo for individuals and is a series of digits for companies."
},
"is_company": {
"type": "boolean",
"description": "Is Company"
}
},
"required": [
"name",
"profile_id"
]
},
"description": "`Linkedin only`"
},
"text": {
"type": "string",
"description": "`Linkedin`: You can add a mention by inserting the index of the corresponding entry from the mentions array between two double braces. Example: Hey {{0}}, check this out !
`Instagram`: You can mention users by inserting their username in the text, like @username."
}
},
"required": [
"PCID",
"post_id",
"account_id",
"text"
]
}
```
***
## unipile\_linkedin\_solve\_job\_checkpoint
Solve a job publishing checkpoint
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------------------- |
| `draft_id` | string | Yes | — | The id of the draft to solve the checkpoint from. |
| `account_id` | string | Yes | — | An Unipile account id. |
| `input` | string | Yes | — | The input value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"draft_id": {
"type": "string",
"description": "The id of the draft to solve the checkpoint from."
},
"account_id": {
"type": "string",
"description": "An Unipile account id."
},
"input": {
"type": "string",
"description": "The input value"
}
},
"required": [
"PCID",
"draft_id",
"account_id",
"input"
]
}
```