Email

Email management endpoints

Get Primary Email

get

Retrieves the user's primary email address.

Authorizations

cookieAuth

sessionidstringRequired

Responses

200

Primary email details

application/json

get

/users/email-change/

HTTPcURLJavaScriptPython

GET /users/email-change/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

200

Primary email details

{
  "id": 1,
  "email": "[email protected]",
  "verified": true,
  "primary": true
}

Request Email Change

post

Initiates a request to change the user's primary email address.

Business Logic:

• Verification: Requires the user's current password to authorize the change.

• Notifications:

  • Sends a confirmation email to the new email address.

  • Sends a confirmation SMS to the user's registered phone number.

•     **URL Format:** The notifications contain a signed URL pointing to the `/users/email-set-primary/{signed_email}/{user_id_key}/` endpoint.

Dynamic Settings:

• NO_REPLY_EMAIL: Sender address for the email.

Notes:

• The signed link is valid for 7 days.

Authorizations

cookieAuth

sessionidstringRequired

Header parameters

X-CSRFTokenstringRequired

CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.

Example: abc123def456ghi789

CookiestringRequired

Session ID and CSRF token cookies. Format: sessionid=<id>; osessionid=<id>; csrftoken=<token>

Example: sessionid=abc123def456; osessionid=abc123def456; csrftoken=xyz789

Body

application/json

userintegerRequired

User ID.

emailstring · emailRequired

The new email address. Must be different from the current email and not already in use.

passwordstring · passwordRequired

The user's current password. Required for verification.

Responses

200

Email change requested

No content

400

Validation error (e.g., email exists, invalid password)

application/json

post

/users/email-change/

HTTPcURLJavaScriptPython

POST /users/email-change/ HTTP/1.1
Host: sandbox.akinon.com
X-CSRFToken: abc123def456ghi789
Cookie: sessionid=abc123def456; osessionid=abc123def456; csrftoken=xyz789
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "user": 1,
  "email": "[email protected]",
  "password": "password"
}

No content

Set Primary Email

get

Sets a verified email as the primary email address.

Path parameters

signed_emailstringRequired

Signed email string

user_id_keystringRequired

Signed user ID key

Responses

200

Email set as primary

No content

400

Invalid signature or error

application/json

get

/users/email-set-primary/{signed_email}/{user_id_key}/

HTTPcURLJavaScriptPython

GET /users/email-set-primary/{signed_email}/{user_id_key}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

No content

Verify Email

get

Verifies a user's email address via a signed link.

Business Logic:

• Verification: Validates the signed email and user ID.

• Next Step: Upon successful verification, it triggers a notification (Email and SMS) containing the link to set this email as primary.

• URL Format: The new notification contains a signed URL pointing to /users/email-set-primary/{signed_email}/{user_id_key}/.

Path parameters

signed_emailstringRequired

Signed email string

user_id_keystringRequired

Signed user ID key

Responses

200

Email verified

No content

400

Invalid signature

application/json

get

/users/email-verify/{signed_email}/{user_id_key}

HTTPcURLJavaScriptPython

GET /users/email-verify/{signed_email}/{user_id_key} HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

No content

Get User Emails

get

Retrieves the user's primary email address.

Authorizations

cookieAuth

sessionidstringRequired

Responses

200

Primary email details

application/json

get

/users/emails/

HTTPcURLJavaScriptPython

GET /users/emails/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

200

Primary email details

{
  "id": 1,
  "email": "[email protected]",
  "verified": true,
  "primary": true
}

Add Email Address

post

Adds a new email address to the user's account.

Business Logic:

• Notifications:

  • Sends a verification email to the new email address.

  • Sends a verification SMS to the user's registered phone number.

•     **URL Format:** The notifications contain a signed URL pointing to the `/users/email-verify/{signed_email}/{user_id_key}` endpoint.

Dynamic Settings:

• NO_REPLY_EMAIL: Sender address for the email.

Authorizations

cookieAuth

sessionidstringRequired

Header parameters

X-CSRFTokenstringRequired

CSRF token for write operations (POST, PUT, PATCH, DELETE). Required for security when using session authentication. Obtain token from cookie 'csrftoken' or meta tag in HTML.

Example: abc123def456ghi789

CookiestringRequired

Session ID and CSRF token cookies. Format: sessionid=<id>; osessionid=<id>; csrftoken=<token>

Example: sessionid=abc123def456; osessionid=abc123def456; csrftoken=xyz789

Body

application/json

idintegerOptional

Unique identifier for the email address. Read-only.

emailstring · emailOptional

The email address. Required when adding a new email.

verifiedbooleanOptional

Indicates if the email address has been verified. Read-only.

primarybooleanOptional

Indicates if this is the primary email address for the user. Read-only.

Responses

200

Email added successfully

No content

400

Validation error

application/json

post

/users/emails/

HTTPcURLJavaScriptPython

POST /users/emails/ HTTP/1.1
Host: sandbox.akinon.com
X-CSRFToken: abc123def456ghi789
Cookie: sessionid=abc123def456; osessionid=abc123def456; csrftoken=xyz789
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "id": 1,
  "email": "[email protected]",
  "verified": true,
  "primary": true
}

No content