Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

The project to create the property in.

Body

application/json

Property definition including key, type, and optional fallback value.

Custom contact-field definition. Keys and types cannot be changed after creation.

key
string
required

Project-unique alphanumeric or underscore key, up to 50 characters.

Maximum string length: 50
Pattern: ^[A-Za-z0-9_]+$
type
enum<string>
required

Value type accepted for the property.

Available options:
string,
number
fallbackValue
string

Optional value returned when a contact has no value for this property.

Response

Contact property created.

createdAt
string
required
id
string
required
key
string
required
object
string
required
projectId
string
required
type
string
required
updatedAt
string
required
fallbackValue
string