Skip to main content
PUT
/
v4
/
subscribers
/
{id}
Update a subscriber
curl --request PUT \
  --url https://api.kit.com/v4/subscribers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Kit-Api-Key: <api-key>' \
  --data '
{
  "first_name": "Alice",
  "email_address": "alice@convertkit.dev",
  "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": ""
  }
}
'
{
  "subscriber": {
    "id": 378,
    "first_name": "Alice",
    "email_address": "alice@convertkit.dev",
    "state": "active",
    "created_at": "2023-02-17T11:43:55Z",
    "fields": {
      "birthday": "Feb 17",
      "last_name": "Lamarr",
      "source": "landing page"
    }
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Path Parameters

​
id
integer
required

Body

application/json
​
email_address
string
required
​
first_name
string | null
​
fields
object

Custom field values keyed by the custom field's key (e.g. last_name, not Last Name). Unknown keys are ignored and reported in the response warnings array.

Response

Updates the subscriber's email address and first name

​
subscriber
object
required
​
warnings
string[]

Present only when the request referenced custom field keys that don't exist on the account. Each entry names an unknown key that was ignored; the subscriber is still created or updated.