Skip to content

Latest commit

 

History

History
125 lines (86 loc) · 4.66 KB

WebformsApi.md

File metadata and controls

125 lines (86 loc) · 4.66 KB

Keap\Core\V2\WebformsApi

All URIs are relative to https://api.keap.com/crm/rest, except if the operation defines another base path.

Method HTTP request Description
getHtml() GET /v2/webforms/{webform_id}:data Get Webform HTML
listWebforms() GET /v2/webforms List Webforms with filter

getHtml()

getHtml($webform_id): string

Get Webform HTML

Returns the HTML

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Keap\Core\V2\Api\WebformsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$webform_id = 'webform_id_example'; // string | webform_id

try {
    $result = $apiInstance->getHtml($webform_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebformsApi->getHtml: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
webform_id string webform_id

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listWebforms()

listWebforms($filter, $order_by, $page_size, $page_token): \Keap\Core\V2\Model\ListWebformsResponse

List Webforms with filter

Retrieves a list of webforms

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Keap\Core\V2\Api\WebformsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$filter = 'filter_example'; // string | Filter to apply, allowed fields are: - (String) `name` - (String) `webform_type` - (String) `since_create_time` - (String) `until_create_time` - (String) `since_update_time` - (String) `until_update_time`  You will need to apply the `==` operator to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples: - `filter=name%3D%3DContact Us` - `filter=webform_type%3D%3Dlegacy`
$order_by = 'order_by_example'; // string | Attribute and direction to order items. One of the following fields: - `name` - `webform_type` - `create_time` - `update_time`  One of the following directions: - `asc` - `desc`
$page_size = 0; // int | Total number of items to return per page
$page_token = 'page_token_example'; // string | Page token

try {
    $result = $apiInstance->listWebforms($filter, $order_by, $page_size, $page_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebformsApi->listWebforms: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
filter string Filter to apply, allowed fields are: - (String) `name` - (String) `webform_type` - (String) `since_create_time` - (String) `until_create_time` - (String) `since_update_time` - (String) `until_update_time` You will need to apply the `==` operator to check the equality of one of the filters with your searched word, in the encoded form `%3D%3D`. For the filters listed above, here are some examples: - `filter=name%3D%3DContact Us` - `filter=webform_type%3D%3Dlegacy` [optional]
order_by string Attribute and direction to order items. One of the following fields: - `name` - `webform_type` - `create_time` - `update_time` One of the following directions: - `asc` - `desc` [optional]
page_size int Total number of items to return per page [optional]
page_token string Page token [optional]

Return type

\Keap\Core\V2\Model\ListWebformsResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]