Skip to content

lubb-force ​

← All modules

10 endpoints.

GET /api/v1/lubb-force/channel/handoffs ​

List Channel Handoffs

A system sees only the hand-offs it sent: Lubb Desk by conversation, Lubb Team by the mailbox that asked (requester).

Parameters

NameInRequiredTypeDescription
statusqueryno
toqueryno
account_idqueryno
conversation_idqueryno
requesterqueryno
limitquerynointeger
x-lubb-force-secretheaderno

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response List Channel Handoffs Api V1 Lubb Force Channel Handoffs Get"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/lubb-force/channel/handoffs ​

Post Handoff

Parameters

NameInRequiredTypeDescription
x-lubb-force-secretheaderno

Request body

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Payload"
}

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Post Handoff Api V1 Lubb Force Channel Handoffs Post"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/lubb-force/channel/handoffs/resolved ​

Resolved Conversation

Lubb Desk resolved a conversation: its hand-offs come off the channel (channel.remove_for_resolved). Declared before /{handoff_id} so "resolved" is not read as an id.

Parameters

NameInRequiredTypeDescription
x-lubb-force-secretheaderno

Request body

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Payload"
}

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Resolved Conversation Api V1 Lubb Force Channel Handoffs Resolved Post"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/lubb-force/channel/handoffs/answered ​

Answered Conversation

A person replied to the customer in a Lubb Desk conversation: its active hand-offs are done (channel.close_for_answered).

Parameters

NameInRequiredTypeDescription
x-lubb-force-secretheaderno

Request body

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Payload"
}

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Answered Conversation Api V1 Lubb Force Channel Handoffs Answered Post"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

GET /api/v1/lubb-force/channel/handoffs/{handoff_id} ​

Get Channel Handoff

Parameters

NameInRequiredTypeDescription
handoff_idpathyesinteger
x-lubb-force-secretheaderno

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Get Channel Handoff Api V1 Lubb Force Channel Handoffs  Handoff Id  Get"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/lubb-force/channel/handoffs/{handoff_id} ​

Update Channel Handoff

The sending system adds a note (more from the customer), closes it, or sends a chat message that wakes the agent to answer (Lubb Desk's Lubb Force tab, owner 2026-10-05: "lubb force tab must be a chat conversation").

Parameters

NameInRequiredTypeDescription
handoff_idpathyesinteger
x-lubb-force-secretheaderno

Request body

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Payload"
}

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Update Channel Handoff Api V1 Lubb Force Channel Handoffs  Handoff Id  Post"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

GET /api/v1/lubb-force/feed ​

Feed

Parameters

NameInRequiredTypeDescription
statusqueryno
toqueryno
systemqueryno
limitquerynointeger

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Feed Api V1 Lubb Force Feed Get"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/lubb-force/feed ​

Feed Post

Request body

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Payload"
}

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Feed Post Api V1 Lubb Force Feed Post"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

GET /api/v1/lubb-force/feed/{handoff_id} ​

Feed Item

Parameters

NameInRequiredTypeDescription
handoff_idpathyesinteger

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Feed Item Api V1 Lubb Force Feed  Handoff Id  Get"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

POST /api/v1/lubb-force/feed/{handoff_id} ​

Feed Update

Parameters

NameInRequiredTypeDescription
handoff_idpathyesinteger

Request body

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Payload"
}

200 — Successful Response

json
{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Feed Update Api V1 Lubb Force Feed  Handoff Id  Post"
}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Lubb Business Documentation