Skip to main content
POST
/
v4
/
subscribers
Create a subscriber
curl --request POST \
  --url https://api.kit.com/v4/subscribers \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '
{
  "first_name": "Alice",
  "email_address": "alice@convertkit.dev",
  "state": "active",
  "fields": {
    "last_name": "Lamarr",
    "birthday": "Feb 17",
    "source": "landing page",
    "role": "Software developer",
    "company": "Convertkit",
    "postal_code": "83702",
    "website": "convertkit.com",
    "social_media": "https://www.linkedin.com/company/convertkit",
    "how_did_you_hear_about_us": "Social media",
    "interests": "Monetization",
    "coupon": "",
    "phone_number": "555-555-5555",
    "enrolled_in_coaching": "true",
    "lead_score": "87"
  }
}
'
{
  "subscriber": {
    "id": 358,
    "first_name": "Alice",
    "email_address": "alice@convertkit.dev",
    "state": "inactive",
    "created_at": "2023-02-17T11:43:55Z",
    "fields": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.kit.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Body

application/json
​
email_address
string
required
​
first_name
string | null
​
state
enum<string> | null

Create subscriber in this state (active, bounced, cancelled, complained or inactive). Defaults to active.

Available options:
active,
cancelled,
bounced,
complained,
inactive
​
fields
object

Custom field values keyed by the custom field's key (e.g. last_name, not Last Name). Passing an unknown key returns a 422 error.

Response

Returns a 200 and updates the subscriber first name when a subscriber with provided email already exists

​
subscriber
object
required