KIkit
Subscribers

Create a subscriber

Behaves as an upsert. If a subscriber with the provided email address does not exist, it creates one with the specified first name and state. If a subscriber with the provided email address already exists, it updates the first name.<br/><br/>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> Updating the subscriber state with this endpoint is not supported at this time.<br/><strong>NOTE:</strong> We support creating/updating a maximum of 140 custom fields at a time.

post/v4/subscribers

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/subscribers
  • 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

Request body

first_namestring nullable
email_addressstring required
state'active' | 'cancelled' | 'bounced' | 'complained' | 'inactive' nullable

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

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

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

Changes

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