### Get Account Payment Methods Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of available payment methods for the account. Requires a 'User-Key' header. ```http GET {{server}}Account@Payments@Methods Headers: User-Key: {{uk}} ``` -------------------------------- ### Get Account Plans Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves information about the account's current plans. Requires a 'User-Key' header. ```http GET {{server}}Account@Plans Headers: User-Key: {{uk}} ``` -------------------------------- ### Get Account Cancellation Reasons Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of reasons for account cancellation. Requires a 'User-Key' header. ```http GET {{server}}Account@CancelReasons Headers: User-Key: {{uk}} ``` -------------------------------- ### PloomES API: Get Options Tables with Options Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves options tables along with their associated options from the PloomES API. Requires a User-Key header. ```HTTP GET {{server}}Fields@OptionsTables?$expand=Options ``` -------------------------------- ### PloomES API: Get Entities Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves entities from the PloomES API. Requires a User-Key header. ```HTTP GET {{server}}Fields@Entities ``` -------------------------------- ### Get RDStation Integration Behaviors Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves behavior data for the RDStation integration associated with the account. Requires a 'User-Key' header. ```http GET {{server}}Account@RDStationIntegration@Behaviors Headers: User-Key: {{uk}} ``` -------------------------------- ### Get Account Integrations Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves account integration details, including associated fields. Requires a 'User-Key' header for authentication. ```http GET {{server}}Account@Integrations?$expand=Integration($expand=Fields) Headers: User-Key: {{uk}} ``` -------------------------------- ### PloomES API: Get Options Table Options Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves options for a specific options table from the PloomES API. Requires a User-Key header. ```HTTP GET {{server}}Fields@OptionsTables@Options ``` -------------------------------- ### GET /api/Fields@OptionsTables@Options Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of options within the options tables. ```APIDOC ## GET /api/Fields@OptionsTables@Options ### Description Retrieves a list of options available in the options tables. ### Method GET ### Endpoint {{server}}Fields@OptionsTables@Options ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### GET /api/Fields@Entities Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves information about entities associated with fields. ```APIDOC ## GET /api/Fields@Entities ### Description Retrieves a list of entities associated with fields. ### Method GET ### Endpoint {{server}}Fields@Entities ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### GET /api/Fields@Types Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of available field types. ```APIDOC ## GET /api/Fields@Types ### Description Retrieves a list of available types for fields. ### Method GET ### Endpoint {{server}}Fields@Types ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### PloomES API: Get Types Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves types from the PloomES API. Requires a User-Key header. ```HTTP GET {{server}}Fields@Types ``` -------------------------------- ### GET /api/Fields@OptionsTables Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of options tables, with the ability to expand the associated options. ```APIDOC ## GET /api/Fields@OptionsTables ### Description Retrieves a list of options tables. Supports expanding the associated 'Options'. ### Method GET ### Endpoint {{server}}Fields@OptionsTables ### Query Parameters - **$expand** (string) - Optional - Specifies related data to include, 'Options' in this case. ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### GET /api/Fields@Entities@Paths Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves information about the paths of entities related to fields. ```APIDOC ## GET /api/Fields@Entities@Paths ### Description Retrieves information about entity paths associated with fields. ### Method GET ### Endpoint {{server}}Fields@Entities@Paths ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### PloomES API: Get Filters with Expansions Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves filters from the PloomES API, with options to expand related user and team information. Requires a User-Key header. ```HTTP GET {{server}}Filters?$expand=AllowedUsers,AllowedTeams,Fields ``` -------------------------------- ### Get Account Payments Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves account payment information, including payment methods and services. Requires a 'User-Key' header. ```http GET {{server}}Account@Payments?$expand=Method,Service Headers: User-Key: {{uk}} ``` -------------------------------- ### Get Reev Integration Behaviors Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves behavior data for the Reev integration associated with the account. Requires a 'User-Key' header. ```http GET {{server}}Account@ReevIntegration@Behaviors Headers: User-Key: {{uk}} ``` -------------------------------- ### PloomES API: Get Entities Paths Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves entity paths from the PloomES API. Requires a User-Key header. ```HTTP GET {{server}}Fields@Entities@Paths ``` -------------------------------- ### GET /api/Filters Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of filters, with options to expand related data such as allowed users, teams, and fields. ```APIDOC ## GET /api/Filters ### Description Retrieves a list of filters. Supports expanding related entities like 'AllowedUsers', 'AllowedTeams', and 'Fields'. ### Method GET ### Endpoint {{server}}Filters ### Query Parameters - **$expand** (string) - Optional - Specifies related data to include (e.g., 'AllowedUsers,AllowedTeams,Fields'). ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### Get MailChimp Integration Details Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves the current configuration or status of the MailChimp integration for the account. Requires a 'User-Key' header. ```http GET {{server}}Account@MailChimpIntegration Headers: User-Key: {{uk}} ``` -------------------------------- ### PloomES API: Get Fields with Filters Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves fields from the PloomES API, with options to expand related data and filter by various criteria. Requires a User-Key header. ```HTTP GET {{server}}Fields?$expand=Type&$top=10&$filter=contains(Name, 's') and OriginFieldFieldPathId eq null ``` ```HTTP GET {{server}}Fields?$expand=Type&$top=10&$filter=contains(Name, 'Tam') ``` ```HTTP GET {{server}}Fields?$expand=Type&$top=10&$filter=Key eq 'interaction_record_C6E39274-2438-4E48-B9A1-4CF9B407E1C6' ``` -------------------------------- ### GET /api/Fields Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Retrieves a list of fields with options to expand related data, limit results, and filter based on various criteria. ```APIDOC ## GET /api/Fields ### Description Retrieves a list of fields. Supports expanding related data (Type), limiting the number of results, and filtering based on name or other criteria. ### Method GET ### Endpoint {{server}}Fields ### Query Parameters - **$expand** (string) - Optional - Specifies related data to include in the response (e.g., 'Type'). - **$top** (integer) - Optional - Limits the number of results returned. - **$skip** (integer) - Optional - Skips a specified number of results. - **$filter** (string) - Optional - Filters the results based on various conditions (e.g., 'contains(Name, 's')', 'OriginFieldFieldPathId eq null', 'Key eq 'interaction_record_C6E39274-2438-4E48-B9A1-4CF9B407E1C6''). ### Headers - **User-Key** (string) - Required - API key for authentication. ``` -------------------------------- ### PloomES API: Create Options Table Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Creates a new options table in the PloomES system. Requires a User-Key and Content-Type header, along with a JSON request body specifying the table name. ```HTTP POST {{server}}Fields@OptionsTables ``` ```JSON { "Name": "Opções aleatórias" } ``` -------------------------------- ### POST /api/Fields@OptionsTables Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Creates a new options table with a specified name. ```APIDOC ## POST /api/Fields@OptionsTables ### Description Creates a new options table. ### Method POST ### Endpoint {{server}}Fields@OptionsTables ### Request Body - **Name** (string) - Required - The name of the options table. ### Request Example ```json { "Name": "Opções aleatórias" } ``` ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### PloomES API: Create Field Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Creates a new field in the PloomES system. Requires a User-Key and Content-Type header, along with a JSON request body specifying field details. ```HTTP POST {{server}}Fields ``` ```JSON { "Name": "Opção", "EntityId": 2, "SecondaryEntityId": null, "TypeId": 7, "OptionsTable": { "Name": "Opções", "Options": [ { "Name": "OP" } ] }, "Multiple": true, "Required": false } ``` -------------------------------- ### Displaying Sales Information and Responsible Party Details in HTML Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README This snippet showcases how to display additional sales information, such as a date and a description, followed by the contact details of the person responsible for the order. It uses HTML fields for dynamic data insertion. ```html Data ale

 

Informações da venda

[Venda.Informações]

 

 
 
 

Responsável

[Responsável.Nome]

[Responsável.E-mail]

[Responsável.Telefone]

``` -------------------------------- ### Displaying Order Product Details in HTML Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README This snippet demonstrates how to structure HTML table rows to display individual product details within a sales order. It includes fields for product index, name, quantity, unit price, discount, and total, along with currency symbols and formatting. It also shows conditional rendering for product discounts. ```html 1 [Grupo do Produto.Nome] [Produto.Nome] [Produto.Quantidade] [Produto.Moeda] [Produto.Valor unitário] [Produto.Desconto]% [Produto.Moeda] [Produto.Total] ``` -------------------------------- ### Upload Account Logo Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Uploads a logo for the account. Requires 'Content-Type' and 'User-Key' headers. ```http POST {{server}}Account/UploadLogo Headers: Content-Type: application/x-www-form-urlencoded User-Key: {{uk}} ``` -------------------------------- ### PloomES API: Create Options Table Option Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Creates a new option within an options table in the PloomES system. Requires a User-Key and Content-Type header, with a JSON request body specifying the table ID and option name. ```HTTP POST {{server}}Fields@OptionsTables@Options ``` ```JSON { "TableId": 28, "Name": "Maçã" } ``` -------------------------------- ### POST /api/Fields Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Creates a new field with specified properties, including its name, entity association, type, and optional configuration for options tables. ```APIDOC ## POST /api/Fields ### Description Creates a new field with the provided details. ### Method POST ### Endpoint {{server}}Fields ### Request Body - **Name** (string) - Required - The name of the field. - **EntityId** (integer) - Required - The ID of the entity this field belongs to. - **SecondaryEntityId** (any) - Optional - The ID of a secondary entity, if applicable. - **TypeId** (integer) - Required - The ID of the field's type. - **OptionsTable** (object) - Optional - Configuration for an associated options table. - **Name** (string) - Required - The name of the options table. - **Options** (array) - Required - A list of options within the table. - **Name** (string) - Required - The name of an option. - **Multiple** (boolean) - Optional - Indicates if the field can have multiple values. - **Required** (boolean) - Optional - Indicates if the field is mandatory. ### Request Example ```json { "Name": "Opção", "EntityId": 2, "SecondaryEntityId": null, "TypeId": 7, "OptionsTable": { "Name": "Opções", "Options": [ { "Name": "OP" } ] }, "Multiple": true, "Required": false } ``` ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### Configure MailChimp Integration Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Configures or updates the MailChimp integration settings for the account. Requires 'User-Key' and 'Content-Type' headers, along with a JSON request body containing temporary token and redirect URI. ```http POST {{server}}Account@MailChimpIntegration Headers: User-Key: {{uk}} Content-Type: application/json Request Body: { "TemporaryToken": "X", "RedirectUri": "https://new.ploomes.com" } ``` -------------------------------- ### Account API Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Provides endpoints for managing account-related operations such as retrieving integration details, updating account information, uploading logos, managing payments, plans, and cancellations. ```APIDOC ## GET /api/Account@Integrations?$expand=Integration($expand=Fields) ### Description Retrieves account integration details, including expanded integration and fields information. ### Method GET ### Endpoint `{{server}}Account@Integrations?$expand=Integration($expand=Fields)` ### Parameters #### Query Parameters - **$expand** (string) - Required - Specifies the expansion of related data, such as `Integration($expand=Fields)`. ### Request Example N/A ### Response #### Success Response (200) - **integration** (object) - Details about the account integration. - **fields** (array) - List of fields associated with the integration. #### Response Example ```json { "integration": { "id": 1, "name": "Example Integration", "fields": [ { "id": 101, "name": "Field 1" } ] } } ``` ``` ```APIDOC ## PATCH /api/Account(0) ### Description Updates the account information, specifically the account name. ### Method PATCH ### Endpoint `{{server}}Account(0)` ### Parameters #### Request Body - **Name** (string) - Required - The new name for the account. ### Request Example ```json { "Name": "Empresa" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "message": "Account updated successfully." } ``` ``` ```APIDOC ## POST /api/Account/UploadLogo ### Description Uploads a logo for the account. ### Method POST ### Endpoint `{{server}}Account/UploadLogo` ### Parameters #### Headers - **Content-Type** (string) - Required - Set to `application/x-www-form-urlencoded`. - **User-Key** (string) - Required - The user's API key. ### Request Example N/A (This endpoint typically expects form data or multipart/form-data) ### Response #### Success Response (200) - **message** (string) - Confirmation message of the logo upload. #### Response Example ```json { "message": "Logo uploaded successfully." } ``` ``` ```APIDOC ## GET /api/Account@Payments?$expand=Method,Service ### Description Retrieves a list of account payments, expanding details for payment methods and services. ### Method GET ### Endpoint `{{server}}Account@Payments?$expand=Method,Service` ### Parameters #### Query Parameters - **$expand** (string) - Required - Specifies the expansion of related data, such as `Method,Service`. ### Request Example N/A ### Response #### Success Response (200) - **payments** (array) - List of payment objects, each with expanded method and service details. #### Response Example ```json [ { "id": 1, "amount": 100.50, "method": {"id": 1, "name": "Credit Card"}, "service": {"id": 5, "name": "Subscription"} } ] ``` ``` ```APIDOC ## GET /api/Account@Payments@Methods ### Description Retrieves a list of available payment methods for the account. ### Method GET ### Endpoint `{{server}}Account@Payments@Methods` ### Request Example N/A ### Response #### Success Response (200) - **methods** (array) - List of payment method objects. #### Response Example ```json [ { "id": 1, "name": "Credit Card" }, { "id": 2, "name": "Bank Transfer" } ] ``` ``` ```APIDOC ## GET /api/Account@Plans ### Description Retrieves a list of available account plans. ### Method GET ### Endpoint `{{server}}Account@Plans` ### Request Example N/A ### Response #### Success Response (200) - **plans** (array) - List of available plan objects. #### Response Example ```json [ { "id": 1, "name": "Basic Plan", "price": 50.00 } ] ``` ``` ```APIDOC ## GET /api/Account@CancelReasons ### Description Retrieves a list of reasons for account cancellation. ### Method GET ### Endpoint `{{server}}Account@CancelReasons` ### Request Example N/A ### Response #### Success Response (200) - **reasons** (array) - List of cancellation reason objects. #### Response Example ```json [ { "id": 7, "name": "Dissatisfaction" } ] ``` ``` ```APIDOC ## POST /api/Account/Cancel ### Description Cancels the account with specified reasons. ### Method POST ### Endpoint `{{server}}Account/Cancel` ### Parameters #### Headers - **Content-Type** (string) - Required - Set to `application/json`. - **User-Key** (string) - Required - The user's API key. #### Request Body - **Reasons** (array) - Required - A list of cancellation reason objects, each containing `ReasonId` and `Comments`. ### Request Example ```json { "Reasons": [ { "ReasonId": 7, "Comments": "Nada" } ] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of the cancellation. #### Response Example ```json { "message": "Account cancellation requested." } ``` ``` ```APIDOC ## GET /api/Account@RDStationIntegration@Behaviors ### Description Retrieves the behaviors related to the RDStation integration for the account. ### Method GET ### Endpoint `{{server}}Account@RDStationIntegration@Behaviors` ### Request Example N/A ### Response #### Success Response (200) - **behaviors** (array) - List of behaviors associated with RDStation integration. #### Response Example ```json [ { "id": 1, "name": "Lead Created" } ] ``` ``` ```APIDOC ## GET /api/Account@ReevIntegration@Behaviors ### Description Retrieves the behaviors related to the Reev integration for the account. ### Method GET ### Endpoint `{{server}}Account@ReevIntegration@Behaviors` ### Request Example N/A ### Response #### Success Response (200) - **behaviors** (array) - List of behaviors associated with Reev integration. #### Response Example ```json [ { "id": 1, "name": "Contact Synced" } ] ``` ``` ```APIDOC ## GET /api/Account@MailChimpIntegration ### Description Retrieves the MailChimp integration status and details for the account. ### Method GET ### Endpoint `{{server}}Account@MailChimpIntegration` ### Request Example N/A ### Response #### Success Response (200) - **integrationStatus** (string) - The status of the MailChimp integration (e.g., 'Connected', 'Disconnected'). #### Response Example ```json { "integrationStatus": "Connected" } ``` ``` ```APIDOC ## POST /api/Account@MailChimpIntegration ### Description Sets up or updates the MailChimp integration for the account using a temporary token and redirect URI. ### Method POST ### Endpoint `{{server}}Account@MailChimpIntegration` ### Parameters #### Headers - **User-Key** (string) - Required - The user's API key. - **Content-Type** (string) - Required - Set to `application/json`. #### Request Body - **TemporaryToken** (string) - Required - The temporary token obtained from MailChimp authentication. - **RedirectUri** (string) - Required - The URI to redirect to after successful integration. ### Request Example ```json { "TemporaryToken": "X", "RedirectUri": "https://new.ploomes.com" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of the MailChimp integration setup. #### Response Example ```json { "message": "MailChimp integration updated successfully." } ``` ``` -------------------------------- ### Cancel Account Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Initiates the account cancellation process. Requires 'User-Key' and 'Content-Type' headers, along with a JSON request body specifying cancellation reasons. ```http POST {{server}}Account/Cancel Headers: User-Key: {{uk}} Content-Type: application/json Request Body: { "Reasons": [ { "ReasonId": 7, "Comments": "Nada" } ] } ``` -------------------------------- ### Displaying Order Totals and Discounts in HTML Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README This snippet shows how to display the overall order discount and the final order total in an HTML table. It uses conditional rendering for the order discount and applies bold formatting to the final total amount, including currency symbols and numerical formatting. ```html Desconto: [Venda.Desconto]% Total: [Venda.Moeda] [Venda.Valor] ``` -------------------------------- ### POST /api/Fields@OptionsTables@Options Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Creates a new option within a specified options table, linking it by TableId. ```APIDOC ## POST /api/Fields@OptionsTables@Options ### Description Creates a new option within an options table. ### Method POST ### Endpoint {{server}}Fields@OptionsTables@Options ### Request Body - **TableId** (integer) - Required - The ID of the options table to which the option belongs. - **Name** (string) - Required - The name of the option. ### Request Example ```json { "TableId": 28, "Name": "Maçã" } ``` ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### Update Account Information Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Updates account information, such as the company name. Requires 'User-Key' and 'Content-Type' headers, along with a JSON request body. ```http PATCH {{server}}Account(0) Headers: User-Key: {{uk}} Content-Type: application/json Request Body: { "Name": "Empresa" } ``` -------------------------------- ### PloomES API: Update Options Table Option Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Updates an existing option within an options table in the PloomES system. Requires a User-Key and Content-Type header, with a JSON request body containing the updated option name. ```HTTP PATCH {{server}}Fields@OptionsTables@Options(2796) ``` ```JSON { "Name": "Rato bom de briga" } ``` -------------------------------- ### PloomES API: Update Field Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Updates an existing field in the PloomES system using its ID. Requires a User-Key and Content-Type header, with a JSON request body containing the fields to update. ```HTTP PATCH {{server}}Fields('contact_consome') ``` ```JSON { "Name": "Consuma" } ``` -------------------------------- ### PloomES API: Delete Options Table Option Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Deletes an option from an options table in the PloomES system using its ID. Requires a User-Key and Content-Type header. ```HTTP DELETE {{server}}Fields@OptionsTables@Options(182) ``` -------------------------------- ### PloomES API: Calculate Value for Google Sheets Integration Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Calculates a value for a Google Sheets integration in the PloomES API. Requires a User-Key and Content-Type header, with a JSON request body containing variable details. ```HTTP POST {{server}}Fields@GoogleSheetsIntegrations(1)/CalculateValue ``` ```JSON { "Variables": [ { "ID_Variavel": 332, "ID_Campo": 4025, "Variavel": "Teste", "ValorPadrao": "0", "ID_CampoVariavel": 4023, "Fixo_CampoVariavel": false, "ID_Tabela_CampoVariavel": 14, "ID_Tipo_CampoVariavel": 4, "VariableId": 332, "Value": 5 } ] } ``` -------------------------------- ### PATCH /api/Fields@OptionsTables@Options/{id} Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Updates an existing option within an options table, identified by its unique ID. ```APIDOC ## PATCH /api/Fields@OptionsTables@Options/{id} ### Description Updates an existing option within an options table, identified by its unique ID. ### Method PATCH ### Endpoint {{server}}Fields@OptionsTables@Options(2796) ### Request Body - **Name** (string) - Optional - The new name for the option. ### Request Example ```json { "Name": "Rato bom de briga" } ``` ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### PloomES API: Delete Field Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Deletes a field from the PloomES system using its ID. Requires a User-Key and Content-Type header. ```HTTP DELETE {{server}}Fields('contact_shit_text') ``` -------------------------------- ### PATCH /api/Fields/{id} Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Updates an existing field identified by its ID, allowing modification of its properties like name. ```APIDOC ## PATCH /api/Fields/{id} ### Description Updates an existing field identified by its unique ID. ### Method PATCH ### Endpoint {{server}}Fields('contact_consome') ### Request Body - **Name** (string) - Optional - The new name for the field. ### Request Example ```json { "Name": "Consuma" } ``` ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### POST /api/Fields/GoogleSheetsIntegrations/{id}/CalculateValue Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Calculates a value related to Google Sheets integration for a specific field, using provided variables. ```APIDOC ## POST /api/Fields/GoogleSheetsIntegrations/{id}/CalculateValue ### Description Calculates a value for Google Sheets integration using a list of variables. ### Method POST ### Endpoint {{server}}Fields@GoogleSheetsIntegrations(1)/CalculateValue ### Request Body - **Variables** (array) - Required - A list of variables to use for calculation. - **ID_Variavel** (integer) - Required - The ID of the variable. - **ID_Campo** (integer) - Required - The ID of the field associated with the variable. - **Variavel** (string) - Required - The name of the variable. - **ValorPadrao** (string) - Required - The default value of the variable. - **ID_CampoVariavel** (integer) - Required - The ID linking the field and variable. - **Fixo_CampoVariavel** (boolean) - Required - Flag indicating if the link is fixed. - **ID_Tabela_CampoVariavel** (integer) - Required - The ID of the table linking field and variable. - **ID_Tipo_CampoVariavel** (integer) - Required - The ID of the type of the field-variable link. - **VariableId** (integer) - Required - The ID of the variable. - **Value** (any) - Required - The value to be used in the calculation. ### Request Example ```json { "Variables": [ { "ID_Variavel": 332, "ID_Campo": 4025, "Variavel": "Teste", "ValorPadrao": "0", "ID_CampoVariavel": 4023, "Fixo_CampoVariavel": false, "ID_Tabela_CampoVariavel": 14, "ID_Tipo_CampoVariavel": 4, "VariableId": 332, "Value": 5 } ] } ``` ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### DELETE /api/Fields@OptionsTables@Options/{id} Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Deletes an option from an options table, specified by its unique identifier. ```APIDOC ## DELETE /api/Fields@OptionsTables@Options/{id} ### Description Deletes an option from an options table, identified by its unique ID. ### Method DELETE ### Endpoint {{server}}Fields@OptionsTables@Options(182) ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` -------------------------------- ### DELETE /api/Fields/{id} Source: https://raw.githubusercontent.com/laviveti/laviploo/refs/heads/dev/docs/ploomes/README Deletes a field specified by its unique identifier. ```APIDOC ## DELETE /api/Fields/{id} ### Description Deletes a field identified by its unique ID. ### Method DELETE ### Endpoint {{server}}Fields('contact_shit_text') ### Headers - **User-Key** (string) - Required - API key for authentication. - **Content-Type** (string) - Required - Set to 'application/json'. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.