whatsapp API reference

Embed

<a href="https://hermeticor.com/docs/ref-whatsapp"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/434c5d81-ce24-486b-89b5-b60c6bdc2596/social-card.svg?v=3e7ae33eec8b" alt="whatsapp" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/linkedin/accounts

Connected LinkedIn provider accounts with their limits, what ran today, what is queued and recent failures

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/linkedin/accounts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "connectionId": "string",
      "name": "string",
      "health": "string",
      "limits": {
        "visitPerDay": 0,
        "connectPerDay": 0,
        "messagePerDay": 0,
        "likePerDay": 0,
        "inmailPerDay": 0,
        "minGapSec": 0,
        "maxGapSec": 0,
        "hours": {
          "startMin": 0,
          "endMin": 0,
          "weekdays": [
            0
          ],
          "timezone": "string"
        }
      },
      "today": {
        "visit": 0,
        "connect": 0,
        "message": 0,
        "like_post": 0,
        "inmail": 0
      },
      "queued": 0,
      "failures": [
        {
          "at": "2024-01-01T00:00:00Z",
          "kind": "visit",
          "error": "string"
        }
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

connectionIdstringrequired

namestringrequired

healthstringrequired

limitsobjectrequired

Show child parameters

visitPerDayintegerrequired

connectPerDayintegerrequired

messagePerDayintegerrequired

likePerDayintegerrequired

inmailPerDayintegerrequired

= 0

minGapSecintegerrequired

maxGapSecintegerrequired

hoursobjectrequired

todayobjectrequired

Show child parameters

visitintegerrequired

connectintegerrequired

messageintegerrequired

like_postintegerrequired

inmailintegerrequired

queuedintegerrequired

failuresobject[]required

Show child parameters

atstringrequired

kindstringrequired

visit | connect | message | like_post | inmail

errorstringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

PUThttps://hermeticor.com/v1/linkedin/accounts/limits

Set an account's daily limits, spacing between actions and working hours (lower than the maximum only)

Request body

application/json

connectionIdstringrequired

limitsobjectrequired

Show child parameters

visitPerDayintegerrequired

connectPerDayintegerrequired

messagePerDayintegerrequired

likePerDayintegerrequired

inmailPerDayinteger

= 0

minGapSecintegerrequired

maxGapSecintegerrequired

hoursobjectrequired

Show child parameters

startMinintegerrequired

endMinintegerrequired

weekdaysinteger[]required

timezonestringrequired

{
  "connectionId": "string",
  "limits": {
    "visitPerDay": 0,
    "connectPerDay": 0,
    "messagePerDay": 0,
    "likePerDay": 0,
    "inmailPerDay": 0,
    "minGapSec": 0,
    "maxGapSec": 0,
    "hours": {
      "startMin": 0,
      "endMin": 0,
      "weekdays": [
        0
      ],
      "timezone": "string"
    }
  }
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/linkedin/accounts/limits" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string","limits":{"visitPerDay":0,"connectPerDay":0,"messagePerDay":0,"likePerDay":0,"inmailPerDay":0,"minGapSec":0,"maxGapSec":0,"hours":{"startMin":0,"endMin":0,"weekdays":[0],"timezone":"string"}}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

5XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

GEThttps://hermeticor.com/v1/linkedin/actions

LinkedIn actions of the sequences: queued, sent, failed or skipped, newest first

Parameters

connectionIdstringquery

statusstringquery

queued | sent | failed | skipped | manual

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/linkedin/actions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "profileId": "string",
      "workflowId": "string",
      "stepKey": "string",
      "kind": "visit",
      "status": "queued",
      "runAfter": "2024-01-01T00:00:00Z",
      "doneAt": "2024-01-01T00:00:00Z",
      "error": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

connectionIdstringrequired

profileIdstringrequired

workflowIdstringrequired

stepKeystringrequired

kindstringrequired

visit | connect | message | like_post | inmail

statusstringrequired

queued | sent | failed | skipped | manual

runAfterstringrequired

doneAtstringrequired

errorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

5XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

GEThttps://hermeticor.com/v1/linkedin/sequences/{id}/steps

Per step of one sequence: LinkedIn actions run, accepted invitations, replies and failures

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/linkedin/sequences/{id}/steps" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "stepKey": "string",
      "kind": "string",
      "queued": 0,
      "sent": 0,
      "failed": 0,
      "skipped": 0,
      "manual": 0,
      "accepted": 0,
      "replied": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

stepKeystringrequired

kindstringrequired

queuednumberrequired

sentnumberrequired

failednumberrequired

skippednumberrequired

manualnumberrequired

acceptednumberrequired

repliednumberrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

5XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

POSThttps://hermeticor.com/v1/linkedin/messages

Compose a LinkedIn message or InMail to a prospect. Queued like a sequence step: do-not-contact gate, account limits and spacing apply; becomes a task when no account is connected

Request body

application/json

profileIdstringrequired

textstringrequired

inmailboolean

= false

idempotencyKeystring

{
  "profileId": "string",
  "text": "string",
  "inmail": false,
  "idempotencyKey": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/linkedin/messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","text":"string","inmail":false,"idempotencyKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "status": "queued",
  "reason": "string"
}

Schema

idstringrequired

statusstringrequired

queued | manual | skipped

reasonstringrequired

4XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

5XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

GEThttps://hermeticor.com/v1/whatsapp/templates

Registered WhatsApp templates with their approval state

Parameters

connectionIdstringquery

statusstringquery

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/whatsapp/templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "contentTemplateId": "string",
      "name": "string",
      "language": "string",
      "category": "marketing",
      "body": "string",
      "variables": [
        "string"
      ],
      "status": "draft",
      "providerTemplateId": "string",
      "header": {
        "format": "text",
        "text": "string",
        "url": "string",
        "handle": "string"
      },
      "footer": "string",
      "buttons": [
        {
          "type": "quick_reply",
          "text": "string"
        }
      ],
      "rejectionReason": "string",
      "lastSyncedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem135[]required

Show child parameters

idstringrequired

connectionIdstringrequired

contentTemplateIdstringrequired

namestringrequired

languagestringrequired

categorystringrequired

marketing | utility | authentication

bodystringrequired

variablesstring[]required

statusstringrequired

providerTemplateIdstringrequired

headerobjectrequired

Show child parameters

formatstringrequired

text | image | video | document

textstring

urlstring

handlestring

footerstringrequired

buttonsButtonsItem[]required

rejectionReasonstringrequired

lastSyncedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

5XX Default Response

Same as 4XX · GET /v1/linkedin/accounts

Next part

Updated Nov 8, 2026

Was this page helpful?