The apply tags action adds a subscrber to ConvertKit and applies one or more tags. Under the hood, this action calls the tag a subscriber API endpoint. If the call fails, we'll retry it for you.
Adding the apply tags action in the formspree.json
file has the same effect as adding the ConvertKit plugin in the Formspree dashboard.
Formspree.json configuration
Key | Type | Description |
---|---|---|
app |
String | Must be convertkit |
type |
String | Must be applyTags |
tags |
Array | A list of tags to apply to the subscriber (required) |
apiKey |
String | Your ConvertKit API key found here (must be an $ env variable reference, required) |
Example
{
"forms": {
"contact": {
"name": "Contact Form",
"actions": [
{
"app": "convertkit",
"type": "applyTags",
"tags": ["Newsletter"],
"apiKey": "$CONVERTKIT_API_KEY"
}
]
}
}
}
Validation rules
The apply tags action adds the following validation rules implicitly:
Field | Validation Rule |
---|---|
email |
Required |
email |
Type is email |