KIkit
Subscribers

Update a subscriber

If you include a custom field key that does not exist on your account, the request returns an error. Use List custom fields to retrieve existing keys, or Create a custom field to add new fields before setting them for subscribers.<br/><br/><strong>NOTE:</strong> We support creating/updating a maximum of 140 custom fields at a time.

put/v4/subscribers/{id}

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/subscribers/{id}
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Path parameters

idinteger required

Request body

first_namestring nullable
email_addressstring required
fieldsobject

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

warningsstring[]

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.