Subscribers

Update a subscriber's pinned location

Changed on

Updates a subscriber's pinned location. This is a full replacement, not a partial update: city, state_province, country_code (ISO 3166-1 alpha-2), latitude, longitude, and timezone (IANA timezone name, e.g. America/Denver) are all required, so resend the current value for any field you are not changing. Omitting one returns 422. Returns the subscriber's id and the updated location on success.

To create a pin from scratch, use Pin a subscriber's location (POST); to remove the pin entirely, use Delete a subscriber's location. Returns 404 when the subscriber is not found, 422 when a required field is missing or invalid.

patch/v4/subscribers/{subscriber_id}/location

Request

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

subscriber_idinteger required

Request body

Response

Pins the location and returns it

Changes