# Sotto

> The Sotto API and bulk data reference for developers.

## Docs

- [Get brand](https://docs.withsotto.com/api-reference/brand/get-brand.md): Returns information about the brand associated with your API credentials.
- [List custom data fields](https://docs.withsotto.com/api-reference/custom-data/list-custom-data-fields.md): Returns all custom data fields configured for your brand. Use the `field_name` values to populate `custom_data` on user create/update and the `custom_` columns in CSV imports.
- [Upload a file](https://docs.withsotto.com/api-reference/files/upload-a-file.md): Uploads a media file. Send the file as `multipart/form-data`. The returned `id` can be referenced in `media_item_uuids` when sending a message.
- [Send a message](https://docs.withsotto.com/api-reference/messages/send-a-message.md): Sends a message to a user.
- [List segments](https://docs.withsotto.com/api-reference/segments/list-segments.md): Returns all active (non-archived) segments configured for your brand.
- [Create a user](https://docs.withsotto.com/api-reference/users/create-a-user.md): Creates a new user. `phone_number` is required and must be unique for your brand.
- [Delete a user](https://docs.withsotto.com/api-reference/users/delete-a-user.md): Deletes a user. The response returns the user with `is_deleted` set to `true`.
- [Get user by phone number](https://docs.withsotto.com/api-reference/users/get-user-by-phone-number.md): Retrieves a user by their phone number.
- [Update a user](https://docs.withsotto.com/api-reference/users/update-a-user.md): Updates an existing user. Only the fields you include are changed; omitted fields are left untouched.
- [Create a webhook](https://docs.withsotto.com/api-reference/webhooks/create-a-webhook.md): Registers a new webhook subscription. A brand may have multiple webhooks, and the same address may subscribe to the same topic more than once. In non-development environments the `address` must be an HTTPS URL.
- [Get a webhook](https://docs.withsotto.com/api-reference/webhooks/get-a-webhook.md): Retrieves a single webhook subscription by its ID.
- [List webhooks](https://docs.withsotto.com/api-reference/webhooks/list-webhooks.md): Retrieves all webhook subscriptions for your brand.
- [Update a webhook](https://docs.withsotto.com/api-reference/webhooks/update-a-webhook.md): Updates the callback address of an existing webhook subscription.
- [Authentication](https://docs.withsotto.com/authentication.md): Sign every Sotto API request with an HMAC-SHA256 signature.
- [Changelog](https://docs.withsotto.com/changelog.md): Notable changes to the Sotto API and bulk data formats.
- [Errors](https://docs.withsotto.com/errors.md): How the Sotto API reports errors.
- [Click data export](https://docs.withsotto.com/guides/click-export-sftp.md): Link-click events with message and user context, delivered to your SFTP.
- [Bulk data overview](https://docs.withsotto.com/guides/overview.md): Move users, purchases, and click data in and out of Sotto with flat files.
- [Purchase import CSV](https://docs.withsotto.com/guides/purchase-import-csv.md): Import order and line-item data into Sotto.
- [User export](https://docs.withsotto.com/guides/user-export-sftp.md): User profiles, custom data, and segment membership delivered to your SFTP.
- [User import CSV](https://docs.withsotto.com/guides/user-import-csv.md): Create and update users in bulk with a CSV file.
- [Sotto API](https://docs.withsotto.com/introduction.md): Programmatic access to manage users, send messages, and sync data with Sotto.
- [Webhooks](https://docs.withsotto.com/webhooks.md): Subscribe to Sotto events and receive HTTP callbacks when they occur.

## OpenAPI Specs

- [openapi](https://docs.withsotto.com/api-reference/openapi.json)