Contact Form

Get a contact form by ID

get

Paramètres de requête

idstringRequis

The UUID of the contact form to retrieve

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Réponses

200

The contact form has been successfully retrieved.

application/json

idstringRequis

Unique identifier

createdAtstring · date-timeRequis

Creation timestamp

updatedAtstring · date-timeRequis

Last update timestamp

namestringRequis

Internal form name.

descriptionstring · nullableRequis

Internal form description.

Default: null

languageall ofRequis

Language in which the form is written. This language is used to determine the source language for machine translation.

string · enumOptionnelValeurs possibles:

enabledbooleanRequis

Determines if the form is enabled.

autoTranslatebooleanRequis

Whether to automatically translate the form.

submissionCountnumberRequis

Number of submissions recorded for this form.

brandIdstringRequis

Brand ID targeted by the contact form

brandNamestringRequis

Brand name targeted by the contact form

400

Invalid input format.

401

Unauthorized

404

Contact Form not found.

get

/partners/contact-form

HTTPcURLJavaScriptPython

GET /partners/contact-form?id=text HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Accept: */*

{
  "id": "text",
  "createdAt": "2026-03-14T21:12:07.854Z",
  "updatedAt": "2026-03-14T21:12:07.854Z",
  "name": "text",
  "description": "text",
  "language": "af",
  "enabled": true,
  "autoTranslate": true,
  "generalStyle": {
    "fieldRadius": "SHARP",
    "buttonRadius": "SHARP",
    "font": {
      "name": "text",
      "url": "text"
    },
    "titleColor": "text",
    "subtitleColor": "text",
    "groupColor": "text",
    "textColor": "text",
    "accentColor": "text",
    "dividerColor": "text",
    "backgroundColor": "text",
    "labelColor": "text",
    "placeholderColor": "text",
    "fieldBackgroundColor": "text",
    "fieldBorderColor": "text",
    "buttonTextColor": "text",
    "buttonBackgroundColor": "text",
    "buttonBorderColor": "text",
    "logoPosition": 1,
    "coverImagePosition": 1,
    "submissionImagePosition": 1,
    "fieldOptionColor": "text"
  },
  "header": {
    "title": "text",
    "subtitle": "text"
  },
  "body": {
    "buttonText": "text"
  },
  "footer": {
    "display": true,
    "displayLogo": true,
    "backgroundColor": "text",
    "title": "text",
    "text": "text",
    "textColor": "text",
    "iconColor": "text",
    "imagePosition": 1
  },
  "externalLink": {
    "website": "text",
    "twitter": "text",
    "facebook": "text",
    "instagram": "text",
    "linkedin": "text"
  },
  "submission": {
    "title": "text",
    "subtitle": "text",
    "titleColor": "text",
    "subtitleColor": "text"
  },
  "logo": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "footerLogo": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "cover": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "submissionImage": {
    "contentType": "text",
    "url": "text",
    "size": "text",
    "width": 1,
    "height": "text"
  },
  "submissionCount": 1,
  "fields": [
    {
      "id": "text",
      "createdAt": "2026-03-14T21:12:07.854Z",
      "updatedAt": "2026-03-14T21:12:07.854Z",
      "dependencies": [
        "text"
      ],
      "dependencyOf": [
        "text"
      ],
      "group": "text",
      "required": true,
      "label": "text",
      "placeholder": "text",
      "verticalIndex": 1,
      "horizontalIndex": 1,
      "values": [
        "text"
      ],
      "allowCustomValue": true,
      "allowMinReplies": true,
      "minReplies": 1,
      "allowMaxReplies": true,
      "maxReplies": 1,
      "operator": "$and",
      "type": "TEXT"
    }
  ],
  "fieldGroups": [
    {
      "id": "text",
      "createdAt": "2026-03-14T21:12:07.854Z",
      "updatedAt": "2026-03-14T21:12:07.854Z",
      "name": "text",
      "verticalIndex": 1
    }
  ],
  "fieldDependencies": [
    {
      "id": "text",
      "createdAt": "2026-03-14T21:12:07.854Z",
      "updatedAt": "2026-03-14T21:12:07.854Z",
      "field": "text",
      "dependsOnField": "text",
      "operator": "$and",
      "dependsOnFieldValues": [
        {
          "operator": "$eq",
          "value": "text"
        }
      ]
    }
  ],
  "brandId": "text",
  "brandName": "text"
}

List contact forms

post

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps

application/json

limitnumber · min: 1 · max: 100Optionnel

Pagination limit

Default: 10

pagenumber · min: 1Optionnel

Page to retrieve

Default: 1

Réponses

201

The contact forms have been successfully listed.

application/json

400

Invalid input format.

401

Unauthorized

post

/partners/contact-form/list

HTTPcURLJavaScriptPython

POST /partners/contact-form/list HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "limit": 10,
  "page": 1
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-03-14T21:12:07.854Z",
      "updatedAt": "2026-03-14T21:12:07.854Z",
      "name": "text",
      "description": "text",
      "language": "af",
      "enabled": true,
      "autoTranslate": true,
      "generalStyle": {
        "fieldRadius": "SHARP",
        "buttonRadius": "SHARP",
        "font": {
          "name": "text",
          "url": "text"
        },
        "titleColor": "text",
        "subtitleColor": "text",
        "groupColor": "text",
        "textColor": "text",
        "accentColor": "text",
        "dividerColor": "text",
        "backgroundColor": "text",
        "labelColor": "text",
        "placeholderColor": "text",
        "fieldBackgroundColor": "text",
        "fieldBorderColor": "text",
        "buttonTextColor": "text",
        "buttonBackgroundColor": "text",
        "buttonBorderColor": "text",
        "logoPosition": 1,
        "coverImagePosition": 1,
        "submissionImagePosition": 1,
        "fieldOptionColor": "text"
      },
      "header": {
        "title": "text",
        "subtitle": "text"
      },
      "body": {
        "buttonText": "text"
      },
      "footer": {
        "display": true,
        "displayLogo": true,
        "backgroundColor": "text",
        "title": "text",
        "text": "text",
        "textColor": "text",
        "iconColor": "text",
        "imagePosition": 1
      },
      "externalLink": {
        "website": "text",
        "twitter": "text",
        "facebook": "text",
        "instagram": "text",
        "linkedin": "text"
      },
      "submission": {
        "title": "text",
        "subtitle": "text",
        "titleColor": "text",
        "subtitleColor": "text"
      },
      "logo": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "footerLogo": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "cover": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "submissionImage": {
        "contentType": "text",
        "url": "text",
        "size": "text",
        "width": 1,
        "height": "text"
      },
      "submissionCount": 1,
      "fields": [
        {
          "id": "text",
          "createdAt": "2026-03-14T21:12:07.854Z",
          "updatedAt": "2026-03-14T21:12:07.854Z",
          "dependencies": [
            "text"
          ],
          "dependencyOf": [
            "text"
          ],
          "group": "text",
          "required": true,
          "label": "text",
          "placeholder": "text",
          "verticalIndex": 1,
          "horizontalIndex": 1,
          "values": [
            "text"
          ],
          "allowCustomValue": true,
          "allowMinReplies": true,
          "minReplies": 1,
          "allowMaxReplies": true,
          "maxReplies": 1,
          "operator": "$and",
          "type": "TEXT"
        }
      ],
      "fieldGroups": [
        {
          "id": "text",
          "createdAt": "2026-03-14T21:12:07.854Z",
          "updatedAt": "2026-03-14T21:12:07.854Z",
          "name": "text",
          "verticalIndex": 1
        }
      ],
      "fieldDependencies": [
        {
          "id": "text",
          "createdAt": "2026-03-14T21:12:07.854Z",
          "updatedAt": "2026-03-14T21:12:07.854Z",
          "field": "text",
          "dependsOnField": "text",
          "operator": "$and",
          "dependsOnFieldValues": [
            {
              "operator": "$eq",
              "value": "text"
            }
          ]
        }
      ],
      "brandId": "text",
      "brandName": "text"
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  }
}