API (Code)

API Reference

For a complete breakdown of all API capabilities, including additional parameters, responses, and error codes, check out the full API reference: Welcomessage API Reference

Send Message

The Send Message endpoint allows you to send a LinkedIn direct message through a specified campaign using provided user details such as name and LinkedIn URL.

If the LinkedIn URL is not provided, Welcomessage will attempt to find the user’s profile using their first and last name, as well as their email address.

Requirements:

• If the LinkedIn URL is not provided, firstName, lastName, and email are required.
• If the LinkedIn URL is provided, only the linkedinUrl field is required.

POSThttps://app.welcomessage.io/api/campaign/{campaign}/trigger

Authorization

ApiKeyAuth

Path parameters

campaign*string

ID of the campaign.

Body

application/json

emailstring (email)

Email address of the recipient. Required if LinkedIn URL is not provided.

Example: "[e-mail]"

firstNamestring

First name of the recipient. Required if LinkedIn URL is not provided.

Example: "John"

lastNamestring

Last name of the recipient. Required if LinkedIn URL is not provided.

Example: "Doe"

companyNamestring

Company name of the recipient.

Example: "TechCorp"

linkedinUrlstring

LinkedIn profile URL of the recipient. Required if firstName, lastName, and email are not provided.

Example: "https://www.linkedin.com/in/johndoe/"

custom_variable_1string

Custom Variable 1

Example: "CustomValue1"

custom_variable_2string

Custom Variable 2

Example: "CustomValue2"

custom_variable_3string

Custom Variable 3

Example: "CustomValue3"

custom_variable_4string

Custom Variable 4

Example: "CustomValue4"

custom_variable_5string

Custom Variable 5

Example: "CustomValue5"

Response

200400

Message successfully sent

Body

application/json

validstring

Confirmation that the message was successfully sent.

outputobject

Full response body.

Request

JavaScriptCurlPython

const response = await fetch('https://app.welcomessage.io/api/campaign/{campaign}/trigger', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "valid": "text"
}

Verify API Key

The Verify API Key endpoint is used to ensure that your API key is valid.

POSThttps://app.welcomessage.io/api/auth/verify-api-key

Body

application/json

api_keystring

The API key for authentication.

Example: "your_api_key_here"

Response

200401

Valid API Key

Body

application/json

validstring

Verification success flag.

outputobject

Full response body.

Request

JavaScriptCurlPython

const response = await fetch('https://app.welcomessage.io/api/auth/verify-api-key', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401

{
  "valid": "text"
}