Profile

Authenticated profile retrieval and updates

Retrieve user profile

get

Authorizations

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses

200

Profile retrieved

application/json

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

401

Authentication required

get/users/profile/

GET /users/profile/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
Accept: */*

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z"
}

Update user profile

put

Updates profile fields. Required fields are driven by USER_REQUIRED_FIELDS (System Configuration).

Authorizations

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

X-CSRFTokenstringRequired

CSRF token header for unsafe methods (POST/PUT/PATCH/DELETE)

Body

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

Responses

200

Profile updated

application/json

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

400

Validation error

401

Authentication required

put/users/profile/

PUT /users/profile/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
X-CSRFToken: text
Content-Type: application/json
Accept: */*
Content-Length: 355

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z"
}

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z"
}

Partially update user profile

patch

Authorizations

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

X-CSRFTokenstringRequired

CSRF token header for unsafe methods (POST/PUT/PATCH/DELETE)

Body

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

Responses

200

Profile updated

application/json

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

400

Validation error

401

Authentication required

patch/users/profile/

PATCH /users/profile/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
X-CSRFToken: text
Content-Type: application/json
Accept: */*
Content-Length: 355

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z"
}

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z"
}

Retrieve loyalty-enabled profile

get

Authorizations

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

Responses

200

Profile retrieved

application/json

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

codestring · nullableRequired

Verification code for phone changes

resendbooleanRequired

Request a new verification code

401

Authentication required

get/users/profile-with-loyalty/

GET /users/profile-with-loyalty/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
Accept: */*

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z",
  "code": null,
  "resend": true
}

Update profile with loyalty sync

put

Updates profile and, when configured, synchronizes loyalty data using CUSTOMER_LOYALTY_CARD_SERVICE (Dynamic Configuration). Phone changes require SMS verification (code + resend flow).

Authorizations

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

X-CSRFTokenstringRequired

CSRF token header for unsafe methods (POST/PUT/PATCH/DELETE)

Body

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

codestring · nullableRequired

Verification code for phone changes

resendbooleanRequired

Request a new verification code

Responses

200

Profile updated

application/json

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

codestring · nullableRequired

Verification code for phone changes

resendbooleanRequired

Request a new verification code

202

Verification code sent for phone confirmation

400

Validation error

401

Authentication required

put/users/profile-with-loyalty/

PUT /users/profile-with-loyalty/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
X-CSRFToken: text
Content-Type: application/json
Accept: */*
Content-Length: 381

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z",
  "code": null,
  "resend": true
}

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z",
  "code": null,
  "resend": true
}

Partially update profile with loyalty sync

patch

Authorizations

CookiestringRequired

Session cookie (e.g., sessionid=abc123)

Header parameters

CookiestringRequired

Session cookie header (e.g. sessionid=abc123)

X-CSRFTokenstringRequired

CSRF token header for unsafe methods (POST/PUT/PATCH/DELETE)

Body

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

codestring · nullableRequired

Verification code for phone changes

resendbooleanRequired

Request a new verification code

Responses

200

Profile updated

application/json

idintegerRequired

first_namestring · max: 50Required

last_namestring · max: 50Required

email_allowedbooleanRequired

sms_allowedbooleanRequired

whatsapp_allowedbooleanRequired

call_allowedboolean · nullableRequired

avatarstring · nullableOptional

emailstring · emailRequired

phonestring · nullableRequired

date_of_birthstring · nullableOptional

genderstring,null · enum · nullableRequiredPossible values:

language_codestringRequired

date_joinedstring · date-timeRequired

codestring · nullableRequired

Verification code for phone changes

resendbooleanRequired

Request a new verification code

202

Verification code sent for phone confirmation

400

Validation error

401

Authentication required

patch/users/profile-with-loyalty/

PATCH /users/profile-with-loyalty/ HTTP/1.1
Host: sandbox.akinon.com
Cookie: text
X-CSRFToken: text
Content-Type: application/json
Accept: */*
Content-Length: 381

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z",
  "code": null,
  "resend": true
}

{
  "id": 1,
  "first_name": "text",
  "last_name": "text",
  "email_allowed": true,
  "sms_allowed": true,
  "whatsapp_allowed": true,
  "call_allowed": null,
  "avatar": null,
  "email": "name@gmail.com",
  "phone": null,
  "date_of_birth": null,
  "gender": "male",
  "genders": [
    "male"
  ],
  "language_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "date_joined": "2026-01-01T00:00:00.000Z",
  "code": null,
  "resend": true
}

PreviousAuthentication

NextRegistration

Last updated 9 months ago

Was this helpful?