> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Persat

> Add a bot to Persat using the official integration.

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01K75D7C0JTQ5FY058T1187G32)
*v1.0.0*

The official Persat integration allows your bot to interact with your Persat clients.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Persat account](https://www.persat.com.ar/sesion)

**1. Install the integration in Botpress**

First, install the integration to your bot:

1. In Botpress Studio, select \*\* Explore Hub\*\* in the upper-right corner.
2. Search for the **Persat** integration, then select **Install Integration**.

In the **Configuration** menu, you should see one field: **API Key**

Leave this empty for now—you'll come back to it after creating your Persat API key.

**2. Create a Persat API key**

Next, create a Persat API key:

1. [Log in to your Persat account](https://www.persat.com.ar/sesion).
2. Select your avatar in the upper-right corner, then select **Integraciones y Partners**.
3. Select **Integra con nuestra API**, then go to **API keys**.
4. Create and copy a new API key. When prompted to configure its access level, make sure you select **Acceso Total** (complete access).

**3. Configure the integration in Botpress**

Now, you can finish setting up the integration in Botpress:

1. In the integration's **API key** field, paste your Persat API key.
2. Select **Save Configuration**.

> [!TIP]
>
> Your Persat integration is ready. You can use its [Cards](#cards) to interact with your Persat clients.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Create Client

Create a new client

**input** `object`

**uid\_client** `string` *required*

The customer number/ID (alphanumeric). Must be unique.

**company\_name** `string` *required*

**company\_description** `string`

Client description.

**latitude** `number`

Customer location, latitude.

**longitude** `number`

Customer location, longitude.

**service\_time** `number`

Service time. Used by the routing algorithm.

**wt** `array`

Opening and closing times of the establishment. Should contain exactly 2 numbers: \[open, close] times in minutes.

**street** `string`

Street where the client is located (exclude number).

**street\_nbr** `string`

Street number.

**neighborhood** `string`

Neighborhood, e.g. 'Devoto'.

**city** `string`

City, e.g. 'CABA'.

**country** `string`

Country, e.g. 'Argentina'.

**custom\_fields** `string`

JSON string containing fieldId:value pairs, e.g. \{"123":"Retail"}

**type\_id** `number`

Client type identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**group\_id** `number`

Client group identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**output** `object`

**success** `boolean` *required*

**data** `object` *required*

**uid\_client** `string` *required*

The customer number/ID (alphanumeric). Must be unique.

**company\_name** `string`

Client name, company name, or trade name.

**company\_description** `string`

Client description.

**latitude** `number`

Customer location, latitude.

**longitude** `number`

Customer location, longitude.

**service\_time** `number`

Service time. Used by the routing algorithm.

**wt** `array`

Opening and closing times of the establishment. Should contain exactly 2 numbers: \[open, close] times in minutes.

**street** `string`

Street where the client is located (exclude number).

**street\_nbr** `string`

Street number.

**neighborhood** `string`

Neighborhood, e.g. 'Devoto'.

**city** `string`

City, e.g. 'CABA'.

**country** `string`

Country, e.g. 'Argentina'.

**last\_updated** `string`

Last update timestamp (ISO 8601).

**custom\_fields** `object`

**type\_id** `number`

Client type identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**group\_id** `number`

Client group identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

### Get Client

Retrieves client from their uid\_client

**input** `object`

**uid\_client** `string` *required*

**output** `object`

**success** `boolean` *required*

**data** `object` *required*

**uid\_client** `string` *required*

The customer number/ID (alphanumeric). Must be unique.

**company\_name** `string`

Client name, company name, or trade name.

**company\_description** `string`

Client description.

**latitude** `number`

Customer location, latitude.

**longitude** `number`

Customer location, longitude.

**service\_time** `number`

Service time. Used by the routing algorithm.

**wt** `array`

Opening and closing times of the establishment. Should contain exactly 2 numbers: \[open, close] times in minutes.

**street** `string`

Street where the client is located (exclude number).

**street\_nbr** `string`

Street number.

**neighborhood** `string`

Neighborhood, e.g. 'Devoto'.

**city** `string`

City, e.g. 'CABA'.

**country** `string`

Country, e.g. 'Argentina'.

**last\_updated** `string`

Last update timestamp (ISO 8601).

**custom\_fields** `object`

**type\_id** `number`

Client type identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**group\_id** `number`

Client group identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

### Submit Form

Submits form

**input** `object`

**uid\_client** `string` *required*

**df\_data** `object` *required*

**schema\_id** `number` *required*

**formvalues** `string` *required*

JSON string containing widgetId:value pairs, e.g. \{"widget-1":"Yes"}

**output** `object`

**success** `boolean` *required*

**data** `object` *required*

**\_id** `string` *required*

**created** `string` *required*

**created\_by\_user\_name** `string` *required*

**created\_by\_user\_id** `number` *required*

**client** `object` *required*

**id** `number` *required*

**name** `string` *required*

**uid\_client** `string` *required*

**df\_data** `object` *required*

**schema\_id** `number` *required*

**results** `object` *required*

**last\_updated** `string` *required*

**formvalues** `object` *required*

Key-value pairs of form field answers.

**state** `object` *required*

**color** `string` *required*

**deleted** `boolean` *required*

**id** `number` *required*

**name** `string` *required*

### Update Client

Update client information

**input** `object`

**uid\_client** `string` *required*

The customer number/ID (alphanumeric). Must be unique.

**company\_name** `string`

Client name, company name, or trade name.

**company\_description** `string`

Client description.

**latitude** `number`

Customer location, latitude.

**longitude** `number`

Customer location, longitude.

**service\_time** `number`

Service time. Used by the routing algorithm.

**wt** `array`

Opening and closing times of the establishment. Should contain exactly 2 numbers: \[open, close] times in minutes.

**street** `string`

Street where the client is located (exclude number).

**street\_nbr** `string`

Street number.

**neighborhood** `string`

Neighborhood, e.g. 'Devoto'.

**city** `string`

City, e.g. 'CABA'.

**country** `string`

Country, e.g. 'Argentina'.

**custom\_fields** `string`

JSON string containing fieldId:value pairs, e.g. \{"123":"Retail"}

**type\_id** `number`

Client type identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**group\_id** `number`

Client group identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**output** `object`

**success** `boolean` *required*

**data** `object` *required*

**uid\_client** `string`

The customer number/ID (alphanumeric). Must be unique.

**company\_name** `string`

Client name, company name, or trade name.

**company\_description** `string`

Client description.

**latitude** `number`

Customer location, latitude.

**longitude** `number`

Customer location, longitude.

**service\_time** `number`

Service time. Used by the routing algorithm.

**wt** `array`

Opening and closing times of the establishment. Should contain exactly 2 numbers: \[open, close] times in minutes.

**street** `string`

Street where the client is located (exclude number).

**street\_nbr** `string`

Street number.

**neighborhood** `string`

Neighborhood, e.g. 'Devoto'.

**city** `string`

City, e.g. 'CABA'.

**country** `string`

Country, e.g. 'Argentina'.

**last\_updated** `string`

Last update timestamp (ISO 8601).

**custom\_fields** `object`

**type\_id** `number`

Client type identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.

**group\_id** `number`

Client group identifier. Must be valid; otherwise, a 409 CONFLICT will be returned.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.