Create a cotact request custom form

PUT

https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/{directory_id}/forms/contact-request/

Create and configure a new custom contact request form for the specified directory.
This will override the current form being used, if any.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

The new form was successfully created and set as active

Bodyapplication/json

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories//forms/contact-request/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "groups": [
        {
            "key": "string",
            "title": "string",
            "description": "string",
            "disabled": false
        }
    ],
    "fields": [
        {
            "type": "string",
            "groups": [
                "string"
            ],
            "attributes": {
                "label": "string",
                "placeholder": "string",
                "export_label": "string",
                "required": true,
                "order": 0,
                "hidden": true,
                "system_key": "string",
                "min_length": 0,
                "max_length": 0,
                "min_value": "string",
                "max_value": "string",
                "precision": 0,
                "decimals": 0,
                "currency_symbol": "string",
                "currency_code": "string",
                "min_choices": 0,
                "max_choices": 0
            },
            "key": "string",
            "options": [
                {
                    "value": "string",
                    "order": 0,
                    "system_key": "string"
                }
            ],
            "overrides": {
                "attributes": [
                    {
                        "attribute": "string",
                        "value": true
                    }
                ],
                "conditions": [
                    {
                        "key": "string",
                        "operator": "equals",
                        "value": "string"
                    }
                ]
            },
            "input_type": "radiogroup"
        }
    ],
    "is_custom": true
}'

Response Example

200 - response

{
    "title": "Updated Contact Request Form",
    "fields": [
        {
            "type": "TextField",
            "attributes": {
                "label": "First Name",
                "system_key": "first_name",
                "export_label": "first_name",
                "required": true,
                "order": 0
            }
        },
        {
            "type": "TextField",
            "attributes": {
                "label": "Company",
                "required": false,
                "order": 1
            }
        }
    ]
}

Modified at 2026-04-13 14:32:54

Get default contact request form

Delete a contact request custom form