propertly.io
DokumentacjaAPILista zmian

Submit a form

POST
/api/v1/forms/responses

Submit a form with field values and optional associations with branch, agent, or offer. Supports various field types and can be made idempotent with an idempotency token. To ensure data is properly populated in the lead panel, the following fields should be present: a field of type PhoneField with fieldName = 'phone_number', a field of type EmailField with fieldName = 'email', a field of type LocationField with fieldName = 'address' containing subfields address_state , address_county, and address_community.

Authorization

APIKeyHeader
headerAuthorization<token>

Request Body

application/json
  1. body
form_identifier*Form Identifier

Identifier for the form type

branch_id?|

Optional branch association

agent_id?|

Optional agent association

offer_id?|

Optional offer association

idempotency_token?|

Optional token for idempotent requests

fields*array<||||||>

Form fields with values and optional labels

Response Body

Form successfully submitted

application/json
  1. response
form_response_id*Form Response Id

ID of the submitted form

Formatuuid
created*Created

Whether the form was newly created or already existed

created_at*Created At

When the form was created

Formatdate-time
curl -X POST 'https://headless-cms.propertly.io/api/v1/forms/responses' \  -H 'Content-Type: application/json' \  -d '{  "form_identifier": "string",  "fields": [    {      "key": "string",      "value": "string"    }  ]}'
{  "form_response_id": "123e4567-e89b-12d3-a456-426614174000",  "created": true,  "created_at": "2025-08-18T11:45:30.000Z"}

Ostatnia aktualizacja