Create a contact request custom form

PUT

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

PUT

/api/directory/private/v1alpha/directories/:directoryId/forms/contact-request/

curl -X PUT https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/directoryId/forms/contact-request/ \
     -H "Authorization: Token  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "Contact request form",
  "fields": []
}'

{
  "title": "Updated Contact Request Form",
  "fields": [
    {
      "type": "text",
      "attributes": {
        "label": "First Name",
        "placeholder": "John",
        "exportLabel": "first_name",
        "internalLabel": "partnerpage-first_name",
        "required": true,
        "order": 0,
        "hidden": false,
        "systemKey": "first_name",
        "customizable": false,
        "minLength": 0,
        "maxLength": 255
      },
      "id": "6bc20308-f4c7-4608-acba-4186d4c5a458",
      "overrides": null
    },
    {
      "type": "text",
      "attributes": {
        "label": "Company size",
        "placeholder": "Enter size",
        "exportLabel": "Company size",
        "internalLabel": "company_size",
        "required": false,
        "order": 1,
        "hidden": false,
        "systemKey": null,
        "customizable": false,
        "minLength": 0,
        "maxLength": 255
      },
      "id": "7cd31419-e5d8-5719-bdcb-5297e5d6b569",
      "overrides": null
    },
    {
      "type": "consent",
      "attributes": {
        "label": "I agree to this",
        "placeholder": null,
        "exportLabel": null,
        "internalLabel": "I agree to this",
        "required": false,
        "order": 2,
        "hidden": false,
        "systemKey": null,
        "customizable": false
      },
      "id": "8de4252a-f6e9-6820-cedc-63a8f6e7c67a",
      "overrides": null
    }
  ],
  "isCustom": true
}

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

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the generic directory to configure the form for

Request

This endpoint expects an object.

titlestringRequired>=1 character

fieldslist of objectsRequired

groupslist of objectsOptional

Response

The new form was successfully created and set as active

titlestring

fieldslist of objects

isCustomboolean

groupslist of objectsOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error