Skip to content

Commit 06398ee

Browse files
docs: add warmup response to Get LinkedIn Account endpoint
Co-Authored-By: Adil <adil@lix-it.com>
1 parent 290328e commit 06398ee

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

source/includes/_account.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ This endpoint retrieves LinkedIn accounts attached to your team.
108108
109109
### HTTP Request
110110
111-
`PUT https://api.lix-it.com/v1/account/linkedin/account`
111+
`GET https://api.lix-it.com/v1/account/linkedin/account`
112112
113113
### Query Parameters
114114
@@ -118,7 +118,7 @@ viewer_id | The LinkedIn account ID to retrieve.
118118
119119
```shell
120120
curl -X GET "https://api.lix-it.com/v1/account/linkedin/account?viewer_id=alfie-lambert" \
121-
-H "Authorization: lixApiKey
121+
-H "Authorization: lixApiKey"
122122
```
123123
124124
```python
@@ -135,7 +135,20 @@ print(response.json())
135135
> The above command returns JSON structured like this:
136136
```json
137137
{
138-
"viewer_id": "alfie-lambert",
139-
"numAvailableTokens": 10
138+
"viewerId": "alfie-lambert",
139+
"linkedInReady": true,
140+
"salesNavigatorReady": false,
141+
"warmup": {
142+
"status": "warming",
143+
"details": {
144+
"active_days": 2,
145+
"daily_limit": 100,
146+
"hourly_limit": 40,
147+
"max_daily_limit": 500,
148+
"max_hourly_limit": 100
149+
}
150+
}
140151
}
141152
```
153+
154+
The `warmup` object is only present when the account warmup feature is enabled for the account. When warmup is complete the `status` field becomes `"completed"` and the `active_days` and limits reflect the final tier.

0 commit comments

Comments
 (0)