Skip to main content
PUT
/
agents
/
{id}
Update Agent Settings
curl --request PUT \
  --url https://api.kakiyo.com/v1/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workingHours": {
    "days": "1:1:1:1:1:0:0",
    "start": "08:00",
    "stop": "18:00"
  },
  "limits": {
    "invitationsMin": 20,
    "invitationsMax": 30,
    "messagesMin": 100,
    "messagesMax": 150
  },
  "settings": [
    {
      "key": "skipInNetwork",
      "value": true
    }
  ]
}
'
{
  "id": "agent_12345abcde",
  "message": "Agent settings updated successfully"
}

Endpoint

PUT https://api.kakiyo.com/v1/agents/:agentId

Path Parameters

ParameterTypeRequiredDescription
agentIdstringYesThe agent ID to update

Request Body

All sections are optional. You can update just one section or multiple at once.

Working Hours

FieldTypeDescription
daysstringWorking days (Mon-Sun). Format: 1:1:1:1:1:0:0 where 1=active, 0=off
startstringStart time in HH:MM format (24-hour)
stopstringEnd time in HH:MM format (24-hour)

Limits

FieldTypeDescription
invitationsMinintegerMinimum daily invitations (1-100)
invitationsMaxintegerMaximum daily invitations (2-100)
messagesMinintegerMinimum daily messages (1-500)
messagesMaxintegerMaximum daily messages (2-500)

Settings

Array of key-value pairs for behavior settings:
KeyTypeDescription
skipInNetworkbooleanDon’t send messages to prospects already in your LinkedIn network
invitationsOnlybooleanOnly send invitations, skip follow-up messages

Response

{
  "id": "69724b7100331796aae2",
  "message": "Agent settings updated successfully"
}

Example Requests

Update Working Hours Only

curl -X PUT "https://api.kakiyo.com/v1/agents/69724b7100331796aae2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workingHours": {
      "days": "1:1:1:1:1:0:0",
      "start": "08:00",
      "stop": "18:00"
    }
  }'

Update Limits Only

curl -X PUT "https://api.kakiyo.com/v1/agents/69724b7100331796aae2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limits": {
      "invitationsMin": 20,
      "invitationsMax": 30,
      "messagesMin": 100,
      "messagesMax": 150
    }
  }'

Update Settings Only

curl -X PUT "https://api.kakiyo.com/v1/agents/69724b7100331796aae2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "settings": [
      { "key": "skipInNetwork", "value": true }
    ]
  }'

Update Everything

curl -X PUT "https://api.kakiyo.com/v1/agents/69724b7100331796aae2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workingHours": {
      "days": "1:1:1:1:1:0:0",
      "start": "08:00",
      "stop": "18:00"
    },
    "limits": {
      "invitationsMin": 20,
      "invitationsMax": 30,
      "messagesMin": 100,
      "messagesMax": 150
    },
    "settings": [
      { "key": "skipInNetwork", "value": true }
    ]
  }'

Working Days Format

The days parameter uses a colon-separated format representing Monday through Sunday:
PositionDay
1stMonday
2ndTuesday
3rdWednesday
4thThursday
5thFriday
6thSaturday
7thSunday
Examples:
  • 1:1:1:1:1:0:0 - Monday to Friday
  • 1:1:1:1:1:1:0 - Monday to Saturday
  • 0:1:1:1:1:1:0 - Tuesday to Saturday
Changes are applied immediately. If the agent is running, the scheduler is automatically re-triggered with the new settings.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the agent

Body

application/json

Agent settings to update

workingHours
object

Configure when the agent should be active

limits
object

Daily activity limits for the agent

settings
object[]

Agent behavior settings

Example:
[{ "key": "skipInNetwork", "value": true }]

Response

Agent settings updated successfully

id
string
Example:

"agent_12345abcde"

message
string
Example:

"Agent settings updated successfully"