Create a contact property
POST
/v1/contact-properties
curl -X POST "https://us1.platform.bird.com/v1/contact-properties" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"key": "plan",
"type": "string",
"fallback_value": "free"
}'Defines a custom property that contacts in the workspace can carry. The key becomes available in contact data and as a template variable in broadcasts. Keys are unique within the workspace; the key and type cannot be changed after creation.
请求载荷
key
string
必填
The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
type
string
必填
The value type every contact must use for this property. Cannot be changed after creation.
fallback_value
Default used when a contact has no value for this property and the template does not supply an inline fallback. A string, number, or boolean matching the declared type (strings up to 500 characters), or null for no fallback.
响应载荷
id
string
必填
Contact property ID.
key
string
必填
The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
type
string
必填
The value type every contact must use for this property. Cannot be changed after creation.
fallback_value
Default used when a contact has no value for this property and the template does not supply an inline fallback. A string, number, or boolean matching the declared type (strings up to 500 characters), or null when no fallback is set.
archived
boolean
Whether the property is archived. An archived property is rejected in new contact writes and stops rendering in templates, but every value already stored on contacts is preserved. Reactivate it with unarchive.
created_at
string
必填
updated_at
string
必填