👼Leads

POST Lead/Create

{
  "botId": "int",
  "name": "string",
  "destination": "string",
  "test": "bool"
}

// Returns ID of the newly created lead.

• BotId: ID of the bot associated to the lead.

• Name: Name of the lead.

• Destination: Identifier of the lead:

  • Whatsapp: Phone number with extension code. Only digits, no blank spaces.

  • Instagram: User handle.

• Test: It is a test lead or a real one.

POST Lead/Update/Manual

{
  "id": "int",
  "manual": "bool",
}

//Returns a bool indicating whether the update was successful or not

• Id: ID of the lead to update

• Manual: False for the bot to reply automatically. True for manual conversations. It only applies to the specified lead. If the "manual" setting for the bot is enabled, this setting is ignored at lead level.

POST Lead/RemoveTest

Removes all the test leads associated to the bot

{
  "botId": "int",
}

• BotId: Id of the bot

GET Lead/Get/{botId}

Returns the leads that belong to the specified bot ID

[{
  "id": "int",
  "botAccountId": "int",
  "destination": "string",
  "createdOn": "DateTime",
  "updatedOn": "DateTime",
  "unread": "bool",
  "retargeted": "bool",
  "manual": "bool",
  "name": "string",
  "lastMessageReceivedOn": "DateTime?"
}]