Create property

post

https://api.popt.in/v1/properties

Add a custom contact field (for example industry or plan) before writing values via contact upserts or imports. 423 if the account is locked for processing.

Body Params

type

string

enum

required


`text` When the field value is a string.
`number` When the field value is a number.
`date` When the field value is a date.
`boolean` When the field value is a boolean.

Allowed:

label

string

required

length ≤ 50

allow_multiple

boolean | null

This will allow your property to hold an array of values instead of just one at a time.
Example: If a contact submits 'blue' in a poptin, then later submits 'red', both values will be stored like this 'blue, red'.

is_recurring

boolean | null

This will allow your property to be recurring.
E.g. date of birth, anniversary, etc.

default_value

string | null

You should only apply a default property for properties you never want to be empty.
When applied, default values will be applied to all contacts that do not have any value saved for this property.
All default values will be overridden once another value is provided either through conversions or manually.

property_options

array of objects | null, unique

Required for boolean properties. Must include exactly two options - one with value 0 and one with value 1.
Example of a boolean property:

{
  "type": "boolean",
  "label": "Subscribed to newsletter",
  "property_options": [
    { "label": "Yes", "value": "1" },
    { "label": "No", "value": "0" }
  ]
}

property_options

Responses

201PropertyCreatedResponse

401Unauthenticated.

403ForbiddenError

422Validation failed.

423AccountProcessingError

429TooManyRequestsError