> ## Documentation Index
> Fetch the complete documentation index at: https://docs.senderz.app/llms.txt
> Use this file to discover all available pages before exploring further.
# Profiles
> Create, upsert, update, look up and blacklist contacts.
Profiles are contacts. Every write is confined to your workspace by row-level security, and every consent change is logged. All endpoints authenticate with the [`X-Sender-Tenant` + `X-API-Key`](/en/api-reference/authentication) headers.
## The profile object
Contact UUID.
`subscribed` / `unsubscribed` / `never_subscribed` / `cleaned`.
## List profiles
```http theme={null}
GET /api/v1/public/profiles
```
Page size 1–100.
Records to skip.
1-based page (alternative to offset).
Free-text search (max 255).
Filter to a segment (UUID).
`subscribed` / `unsubscribed` / `never_subscribed` / `cleaned`.
`email` or `sms`.
Sort key, e.g. `-createdAt`, `-updatedAt`.
Returns a [paginated](/en/api-reference/pagination) list of profile objects.
## Get a profile by email
```http theme={null}
GET /api/v1/public/profiles/lookup?email=dana@example.com
```
The email to look up.
Returns the profile object, or `404 Profile not found`.
## Get a profile by ID
```http theme={null}
GET /api/v1/public/profiles/:id
```
Returns the profile object.
## Create a profile
```http theme={null}
POST /api/v1/public/profiles
```
Max 320.
Max 32.
Max 128.
Max 128.
Max 64.
Max 10.
Consent enum.
Consent enum.
Consent enum.
Max 64.
Max 64.
Max 64.
Max 4000, or null.
```bash cURL theme={null}
curl -X POST https://api.senderz.app/api/v1/public/profiles \
-H "X-Sender-Tenant: your-workspace-slug" \
-H "X-API-Key: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"email": "dana@example.com",
"firstName": "Dana",
"emailConsent": "subscribed",
"emailConsentSource": "api",
"tags": ["newsletter"]
}'
```
## Upsert a profile
```http theme={null}
PUT /api/v1/public/profiles
```
Same body as **create**. Matches an existing contact by **email or phone** and creates one if none matches. Requires at least one of `email` / `phone`.
## Update a profile by email
```http theme={null}
PATCH /api/v1/public/profiles
```
The email is a **lookup key** — it isn't rewritten unless you pass `newEmail`. Returns `404` if the email isn't found.
Lookup key (max 320).
Rename the contact's email.
Consent enum.
Consent enum.
Consent enum.
Max 4000, or null.
Address-style fields (city, country, zip, DOB, gender, job title) merge into
`customProperties` — they aren't native columns.
## Update a profile by ID
```http theme={null}
PATCH /api/v1/public/profiles/:id
```
Same field set as create, addressed by UUID.
## Blacklist
```http theme={null}
POST /api/v1/public/profiles/blacklist
DELETE /api/v1/public/profiles/blacklist
```
Required unless `contactId` is given.
Contact UUID.
`email`, `sms`, or `both`.
`POST` suppresses the contact on the channel; `DELETE` lifts it. Both return the profile object.