Skip to main content
Resend Docs

Search documentation

Type to search this documentation.

Create a new contact property

POST/contact-propertiesCreate a new contact property

Request body

application/json
objectCreateContactPropertyOptions
fallback_valuevalue

The default value to use when the property is not set for a contact. Must match the type specified in the type field.

Show child attributes
oneOf · 2 options
Option 1string
Option 2number
keystringrequired

The property key. Max length is 50 characters. Only alphanumeric characters and underscores are allowed.

typestringrequired

The property type.

one of "string", "number"

Example request
{
  "fallback_value": "string",
  "key": "string",
  "type": "number"
}

Responses

201OKapplication/json
objectCreateContactPropertyResponseSuccess
idstring

The ID of the contact property.

objectstring

The object type of the response.

Example response
{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "contact_property"
}
Documentation menu