---
title: "Register a sender email address"
method: POST
path: "/appmail/registrations"
tags: ["App Mail Registrations"]
---

# Register a sender email address

`POST /appmail/registrations`

## Request

- Base URL: `https://api.surense.com/api/v1`
- URL: `https://api.surense.com/api/v1/appmail/registrations`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.surense.com/oauth/token`

Creates a PENDING registration for the given email address in the caller's tenant, optionally assigned to a user of the tenant, and publishes an `EAppMailRegistrationCreatedEvent` carrying the confirmation token. The token expires after 12 hours.

Errors (400): email missing; the address is already registered in this tenant; the user is not found in the tenant. An address registered by another tenant is not rejected.

## Request body

- AddRegistrationRequest
  - `userId` string, uuid: Tenant user to assign the registration to. Omit for a tenant-level registration.
  - `email` string: Email address to register. Required; must not already be registered in the tenant.

## Response `200`

OK

- AppMailRegistrationValue: A mailbox registered with AppMail.
  - `tenantId` string, uuid
  - `createdDate` string, date-time
  - `createdBy` string, uuid
  - `creatorName` string
  - `lastModifiedDate` string, date-time
  - `lastModifiedBy` string, uuid
  - `version` integer
  - `id` string, uuid: Registration ID.
  - `email` string: Registered email address.
  - `userId` string, uuid: User the registration is assigned to; null for tenant-level registrations.
  - `userName` string: Full name of the assigned user.
  - `primary` boolean: True if this is the primary registration of the user (their own registered email). Primary registrations cannot be deleted or reassigned.
  - `status` 'PENDING' | 'VERIFIED': PENDING until the address is confirmed through the emailed link, then VERIFIED.
  - `deletable` boolean: Whether the registration can be deleted (false for primary registrations).

---

[API](https://skmtc.dev/surense/apis/appmail-api.md) - [All operations](https://skmtc.dev/surense/apis/appmail-api/llms.txt) - [OpenAPI document](https://skmtc.dev/surense/apis/appmail-api/revisions/dd959778fa2e?raw)