Pin a subscriber's location
pin_subscriber_locationPin a subscriber's location to update delivery and audience membership. Requires confirm=true and full location data.
Instructions
Pin a subscriber's location. May affect delivery, audience membership, published data or irreversible state. Requires confirm=true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Named private account from KIT_ACCOUNTS. Defaults to KIT_DEFAULT_ACCOUNT or the first configured account. | |
| confirm | No | Must be true for audience/delivery changes, publishing, destructive operations and signing-secret changes. Use only for an action requested by the user. | |
| payload | No | Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file. | |
| location | No | ||
| payload_file | No | Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged. | |
| subscriber_id | Yes | Positive subscriber id. |