syncConversation

This method allows you to sync a conversation so you can start polling it for new messages.

typescript

try {
  const workflow = await linkedapi.syncConversation.execute({
    personUrl: "https://www.linkedin.com/in/john-doe",
    days: 14
  });

  const { data, errors } = await linkedapi.syncConversation.result(workflow.workflowId);

  // The list of possible execution errors is below
  if (errors && errors.length > 0) {
    console.warn('Workflow completed with execution errors:');
    errors.forEach(error => {
      console.warn(` - Type: ${error.type}, Message: ${error.message}`);
    });
  } else {
    console.log(`Workflow completed successfully. Syncing until ${data.syncUntil}`);
  }
} catch (e) {
  // A list of all critical errors can be found here:
  // https://linkedapi.io/sdks/handling-results-and-errors/#handling-critical-errors
  if (e instanceof LinkedApiError) {
    console.error(`Critical Error - Type: ${e.type}, Message: ${e.message}`);
  } else {
    console.error('An unexpected, non-API error occurred:', e);
  }
}

python

from linkedapi import SyncConversationParams, LinkedApiError

try:
    workflow = linkedapi.sync_conversation.execute(
        SyncConversationParams(person_url="https://www.linkedin.com/in/john-doe", days=14)
    )

    result = linkedapi.sync_conversation.result(workflow.workflow_id)
    errors = result.errors

    # The list of possible execution errors is below
    if errors:
        print("Workflow completed with execution errors:")
        for error in errors:
            print(f" - Type: {error.type}, Message: {error.message}")
    else:
        print(f"Workflow completed successfully. Syncing until {result.data.sync_until}")
except LinkedApiError as e:
    # A list of all critical errors can be found here:
    # https://linkedapi.io/sdks/handling-results-and-errors/#handling-critical-errors
    print(f"Critical Error - Type: {e.type}, Message: {e.message}")
except Exception as error:
    print("An unexpected, non-API error occurred:", error)

Params

personUrl – public or hashed LinkedIn URL of the person whose conversation you want to synchronize.
days (optional) – how many days the conversation stays synchronized, from 1 to 90. Defaults to 30.

Data

syncUntil – moment when synchronization of this conversation stops. Once it passes, polling keeps returning the messages collected so far, but they are no longer updated. Call this method again for the same person to start a new period; the accumulated history is preserved.

Errors

personNotFound – provided URL is not an existing LinkedIn person.
selfProfileNotAllowed – action cannot be performed on your own profile.

PrevioussendMessage NextsyncInbox