Skip to main content
PATCH
/
leads
/
{leadId}
cURL
curl --request PATCH \
  --url https://api.attent.app/v1/leads/{leadId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "newemail@example.com",
  "timeZone": "America/Los_Angeles",
  "additionalInfo": {
    "newField": "newValue",
    "existingField": "updatedValue",
    "fieldToRemove": null
  },
  "followUpConfig": {
    "1": {
      "hours": 24,
      "channel": "text",
      "strategyIds": "auto"
    },
    "2": {
      "hours": 72,
      "channel": "email"
    },
    "3": {
      "hours": 168,
      "channel": "call",
      "voicemailEnabled": true,
      "strategyIds": [
        "550e8400-e29b-41d4-a716-446655440000",
        "7c9e6679-7425-40de-944b-e07fc1f90ae7"
      ]
    }
  },
  "followUpStep": 1,
  "useStrategiesForFollowUps": true
}
'
{
  "message": "Lead updated successfully."
}

Documentation Index

Fetch the complete documentation index at: https://docs.apten.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Usage Notes

​
Updating additionalInfo

The additionalInfo field uses merge/upsert behavior:
  • New keys are added to the existing additionalInfo
  • Existing keys are updated with new values
  • To delete a key, set its value to null
{
  "additionalInfo": {
    "newKey": "newValue", // Adds new key
    "existingKey": "updated", // Updates existing key
    "oldKey": null // Removes this key
  }
}

​
Follow-up Configuration

The followUpConfig defines the follow-up schedule. Each step must include both hours and channel: 
{
  "useStrategiesForFollowUps": true,
  "followUpConfig": {
    "1": { "hours": 24, "channel": "text", "strategyIds": "auto" },
    "2": { "hours": 72, "channel": "email" },
    "3": { "hours": 168, "channel": "call", "voicemailEnabled": true, "strategyIds": ["550e8400-e29b-41d4-a716-446655440000", "7c9e6679-7425-40de-944b-e07fc1f90ae7"] }
  }
}
Allowed channels: text, call, email Optional properties:
  • voicemailEnabled (boolean): Only valid for call channel. If true, leaves a voicemail when call is not answered.
  • strategyIds (string or string array): Strategy IDs to use for this follow-up step. Use "auto" for automatic selection, or provide an array of specific strategy IDs. Requires useStrategiesForFollowUps to be set to true on the lead.
Channel requirements: - text: Always available (SMS) - call: Requires voice to be enabled on the customer profile - email: Requires email to be enabled on both the customer profile and organization
To stop all follow-ups for a lead, set followUpConfig to an empty object {} . This will cancel any scheduled follow-ups and set the lead to STOPPED state.

​
Follow-up Scheduling Behavior

When updating followUpStep and/or followUpConfig, the timer always resets to now + hours:
  1. Update followUpStep only: Schedules that specific step
  2. Update followUpConfig only: Reschedules with new timing, preserving the current step
  3. Update both: Full reset with the new config starting at the specified step

​
Special followUpStep Values

  • Positive integers (1, 2, 3, …): Schedule that specific follow-up step
  • -1 (STOPPED): Stops all follow-ups for this lead
  • -2 (LONG_TERM): Moves lead to long-term nurture mode

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
leadId
string
required

The ID of the lead to update

Body

application/json

Fields to update on the lead. All fields are optional.

​
email
string

The email address of the lead. Must be a valid email format.

​
timeZone
string

The timezone of the lead in tz database format (e.g. America/New_York).

​
additionalInfo
object

Key-value object to merge with existing additionalInfo. Set a value to null to remove that key.

​
followUpConfig
object

Follow-up schedule configuration. Keys are step numbers (1, 2, 3, etc.), values are objects with hours and channel.

​
followUpStep
integer

The follow-up step to schedule. Use positive integers (1, 2, 3, ...) for specific steps, -1 for STOPPED, or -2 for LONG_TERM.

​
useStrategiesForFollowUps
boolean

Enable strategy-based follow-ups for this lead. Must be true for strategyIds in followUpConfig steps to take effect.

Response

Lead updated successfully.

​
message
string

Returns "Lead updated successfully." when the update completes.