API docs

`POST /lead`

Request headers

Key	Value
`Content-Type`	`application/json`
`x-api-key`	your API key

Request body parameters

Parameter	Required	Type/Example	Description
`campaignId`	`true`	`integer`	Campaign ID
`firstName`	`true`	`string`	First name
`lastName`	`false`	`string`	Last name
`phone`	`true`	+111111 or 111111	Full phone number
`phonecc`	`false`	+11 or 11	Phone code
`ip`	`true`	2.2.8.1337	User's IP address
`domain`	`true`	example.com	Domain where form installed
`email`	`true`	[email protected]	Email
`geo`	`true`	`string`	Geolocation
`clickId`	`true`	cb5sb6	Click ID
`hopper`	`true`	WhatsApp	Hopper
`password`	`false`	password123	User's password
`sub1`	`false`	`string`	Sub 1
`sub2`	`false`	`string`	Sub 2
`sub3`	`false`	`string`	Sub 3
`sub4`	`false`	`string`	Sub 4
`sub5`	`false`	`string`	Sub 5
`sub6`	`false`	`string`	Sub 6
`sub7`	`false`	`string`	Sub 7
`sub8`	`false`	`string`	Sub 8

Response codes

Code	Description
200	Lead successfully registered
403	Invalid API key
400	Bad request
404	Campaign not found

Successful registration response example

{
    "id": 228,
    "autologinUrl": "https://example.com/?pass=1337",
    "password": "gshG3gs"
}

*autologinUrl and password can be null

Bad request response example

[
    "Campaign id is required!",
    "Domain is invalid!",
    "First name is required!",
    "Phone is invalid!",
    "Email is invalid!",
    "Lead was already registered in last 24 hours!"
]

`GET /lead`

Key	Value
`Content-Type`	`application/json`
`x-api-key`	your API key

Query parameters

Parameter	Type/Pattern	Values	Description
`page`	`integer`	Default: `0`	Page number starting from 0
`size`	`integer`	Default: `100` Max: `1000`	Page size
`sort`	`{field},{direction}` Field values: `createdAt` or `lastExternalStatusAt` Direction values: `desc` or `asc`	Default: `createdAt,desc` Examples: `createdAt,asc` `lastExternalStatusAt,desc` `lastExternalStatusAt,asc`	Sorting field and direction separated by comma
`internalStatus`	`enum`	`HOLD` or `FAIL` or `SUCCESS`	Filter by internal status. If not provided - data will not be filtered
`createdFrom`	`dateTime`	Format: `yyyy-MM-dd'T'hh:mm:ss` Examples: `2024-02-13T19:49:54` `2025-11-02T02:02:20`	Filter by created date. If not provided - data will not be filtered
`createdTo`	`dateTime`	Format: `yyyy-MM-dd'T'hh:mm:ss` Examples: `2024-02-13T19:49:54` `2025-11-02T02:02:20`	Filter by created date. If not provided - data will not be filtered
`depositedFrom`	`dateTime`	Format: `yyyy-MM-dd'T'hh:mm:ss` Examples: `2024-02-13T19:49:54` `2025-11-02T02:02:20`	Filter by deposited date. If not provided - data will not be filtered
`depositedTo`	`dateTime`	Format: `yyyy-MM-dd'T'hh:mm:ss` Examples: `2024-02-13T19:49:54` `2025-11-02T02:02:20`	Filter by deposited date. If not provided - data will not be filtered

Response codes

Code	Description
200	Lead successfully registered
403	Invalid API key
400	Bad request

Successful response example

{
    "content": [
        {
            "id": 85459,
            "internalStatus": "SUCCESS",
            "externalStatus": null,
            "createdAt": "2023-12-21T10:57:56.884323",
            "depositedAt": null,
            "isDeposit": false,
            "lastExternalStatusAt": null,
            "errorMessage": null
        },
        {
            "id": 84959,
            "internalStatus": "SUCCESS",
            "externalStatus": "Deposit",
            "createdAt": "2023-12-20T12:02:10.218952",
            "depositedAt": "2023-12-21T09:35:16.321559",
            "isDeposit": true,
            "lastExternalStatusAt": "2023-12-21T09:35:16.329433",
            "errorMessage": null
        }
    ],
    "pageable": {
        "sort": {
            "empty": false,
            "sorted": true,
            "unsorted": false
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 100,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalElements": 2,
    "totalPages": 1,
    "size": 100,
    "number": 0,
    "sort": {
        "empty": false,
        "sorted": true,
        "unsorted": false
    },
    "first": true,
    "numberOfElements": 2,
    "empty": false
}

Bad request response example

[
    "Access denied!",
    "Page must be greater than or equal to 0!",
    "Size must be less than or equal to 1000!",
    "Sort field is invalid!",
    "Sort direction is invalid!"
]