Subscribers

Pin a subscriber's location

Changed on

Pins an explicit location to a subscriber, overriding any location Kit has inferred from open events. Provide city, state_province, country_code (ISO 3166-1 alpha-2, required), latitude, longitude, and timezone (IANA timezone name, e.g. America/Denver). Returns the subscriber's id and the pinned location on success.

If the subscriber already has a pinned location this replaces it. To replace the values on an existing pin, use Update a subscriber's pinned location (PATCH); to remove the pin, use Delete a subscriber's location. The pinned location is returned on Get a subscriber. Returns 404 when the subscriber is not found, 422 when a required field is missing or invalid.

post/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