Developer Portal

Generate Messages API

This API enables you to load your prospects and request LinkedIn messages to be generated.

🠔 Back to Reference Library

Endpoint URL

Message Generation Request Endpoint

Authentication

To ensure the security of data transmission, our API requires API key-based authentication. Include your Koneksi-Start-Messages-Api-Key in the request header for each call. You can find your API key on your Manage Account page within the Koneksi Admin account.

Content Headers

Message Generation Request Endpoint

This endpoint allows you to create a new user (or update an existing user) and associate prospects with that user. The system will process your data and generate customized messages for each prospect.

Request Body

Example request body:

Message Generation Request Endpoint

Description of each User element in the request body. This includes information about the product being taken to market in this campaign.

ElementField typeDescription
full_namestringFull name of the user.
emailstringEmail address of the user (used as the unique ID for that user).
company_namestringCompany name for the product being sold/taken to market.
customer_company_websitestringCompany website URL for the product being sold/taken to market.
short_company_descriptiontextTwo line description of product being taken to market.
benefits_of_producttextBenefits of the product that will be realised by prospects should they use it.
ideal_customer_profiletextDetailed description of typical target prospect and their relevant needs
list_of_painstextProspects' pain points typically solved by the product.
keywordstextKeywords which Koneksi should look for online to find relevant information about the target prospect's company and their needs.

Description of each Prospect element in the request body, nested within the User.

ElementField typeDescription
first_namestringProspect's first name.
last_namestringProspect's last name.
companystringProspect's company name.
customer_website_urlstringProspect's company website URL (if available - this isn't mandatory).
linkedinstringProspect's LinkedIn profile URL.
api_message_typearray of stringsTypes of messages that should be generated for this prospect. Options are: connect, first follow-up, share-material.

Description of each Prospect element in the request body, nested within the User.

ElementField typeDescription
first_namestringProspect's first name.
last_namestringProspect's last name.
companystringProspect's company name.
linkedinstringProspect's Linkedin profile URL.
customer_website_urlstringProspect's company website URL (if available - this isn't mandatory).

Description of each api_message_type option available for each prospect. Each prospect can have one or more of these message types in their api_message_type array:

String option within ArrayDescription
connectA message under 300 characters that will be included within a connection request.
first follow-upNOTE THAT FOLLOW-UP IS HYPHENATED. A first message which is sent if a prospect accepts the connection request.
share-materialNOTE THAT THIS IS HYPHENATED. A message which picks an relevant aspect of a blog, whitepaper or case study and explains to the prospect why they, in particular, might find it helpful or interesting.
event invitation(coming soon!)

Mandatory Fields

The following fields are mandatory in every request:

  • user.full_name (unless already provided)
  • user.email
  • user.company_name (unless already provided)
  • user.customer_company_website (unless already provided)
  • user.short_company_description (unless already provided)
  • user.benefits_of_product (unless already provided)
  • user.ideal_customer_profile (unless already provided)
  • user.list_of_pains (unless already provided)
  • user.keywords (unless already provided)
  • user.prospects_attributes
  • prospects_attributes.first_name
  • prospects_attributes.last_name
  • prospects_attributes.company
  • prospects_attributes.linkedin
  • prospects_attributes.api_message_type (must be an array of strings)

Responses

Koneksi will send a response that contains a code, a description, and if no errors, a secure_request_id. You will need to use that secure_request_id to retrieve the messages via the Retrieve Messages API.

CodeDescription
200The user and prospects were transmitted succesfully. Koneksi will now create or update prospects based on the provided LinkedIn URL and will initiate message generation for each message type specified.
401Unathorized request - either because the API key is incorrect, or because the account is out of credits.
422Unprocessable entity. The information transmitted in the request is not formatted correctly, or is missing required information.
500Internal server error.

We've got you covered

Frequently Asked Questions

We hope this helps, but feel free to reach out to us via Contact Us if there's anything we haven't answered.