Gestiono
Referencia de APIChats / Conversation List

Create Conversation List

POST /v1/conversation-list • validated by `postConversationListSchema`

← Back to full API reference
POST/v1/conversation-listAuthentication required
  • Validated by Zod schema: postConversationListSchema.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • name (required)

    Type: string

  • source

    Type: enum

    Example: contact

  • filter

    Type: object

  • filter.channelTypes

    Type: array

    Example:

  • filter.channelTypes[] (required)

    Type: string

  • filter.form

    Type: object

  • filter.form.id (required)

    Type: number

  • filter.form.phoneField (required)

    Type: string

  • filter.form.nameField (required)

    Type: string

  • filter.purchases

    Type: object

  • filter.purchases.resourceIds (required)

    Type: array

    Example:

  • filter.purchases.resourceIds[] (required)

    Type: number

  • filter.purchases.match

    Type: enum

    Example: ANY

  • filter.purchases.dateRange

    Type: object

  • filter.purchases.dateRange.from

    Type: string

  • filter.purchases.dateRange.to

    Type: string

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "name": "string"
}

Sample response

json
{
  "id": "<value>",
  "list": "<list>"
}

Test this endpoint now

Use your own credentials and execute a live request directly from this page.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

2. Select endpoint

POST/v1/conversation-listAuthentication required

Group: Chats / Conversation List

POST /v1/conversation-list • validated by `postConversationListSchema`

  • Validated by Zod schema: postConversationListSchema.

Body fields

  • namerequired
    Type: string
  • source
    Type: enum
    Ejemplo: contact
  • filter
    Type: object
  • filter.channelTypes
    Type: array
    Ejemplo:
  • filter.channelTypes[]required
    Type: string
  • filter.form
    Type: object
  • filter.form.idrequired
    Type: number
  • filter.form.phoneFieldrequired
    Type: string
  • filter.form.nameFieldrequired
    Type: string
  • filter.purchases
    Type: object
  • filter.purchases.resourceIdsrequired
    Type: array
    Ejemplo:
  • filter.purchases.resourceIds[]required
    Type: number
  • filter.purchases.match
    Type: enum
    Ejemplo: ANY
  • filter.purchases.dateRange
    Type: object
  • filter.purchases.dateRange.from
    Type: string
  • filter.purchases.dateRange.to
    Type: string

3. Prepare request payload

4. Server response

Run a request to inspect the real-time response for your environment.

GET /v1/conversation-list/:id

Previous Page

PATCH /v1/conversation-list

Next Page