Skip to main content
PATCH
/
api
/
v1
/
{app_id}
/
users
/
{user_id}
Error
A valid request URL is required to generate request examples
{
  "additions": {},
  "address": {
    "city": "<string>",
    "country": "<string>",
    "country_code": "<string>",
    "street": "<string>",
    "zip_code": "<string>"
  },
  "app_id": "<string>",
  "attributes": [
    {
      "description": "<string>",
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "template_key": "<string>",
      "translations": {
        "description": {},
        "name": {}
      },
      "values": {}
    }
  ],
  "communication_preferences": {
    "allow_email": true,
    "allow_postal": true,
    "allow_sms": true
  },
  "created_at": "<string>",
  "customer_groups": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>"
    }
  ],
  "email": "<string>",
  "email_verified": true,
  "files": [
    {
      "app_id": "<string>",
      "content_type": "<string>",
      "created_at": "<string>",
      "custom_fields": {},
      "filename": "<string>",
      "id": "<string>",
      "updated_at": "<string>",
      "url": "<string>"
    }
  ],
  "first_name": "<string>",
  "id": "<string>",
  "is_super_admin": true,
  "language": "<string>",
  "last_login_at": "<string>",
  "last_name": "<string>",
  "market": "<string>",
  "market_currency": "<string>",
  "market_id": "<string>",
  "organisations": [
    {
      "app_id": "<string>",
      "attributes": [
        {
          "description": "<string>",
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "template_key": "<string>",
          "translations": {
            "description": {},
            "name": {}
          },
          "values": {}
        }
      ],
      "billing_address": [
        {
          "city": "<string>",
          "co_address": "<string>",
          "company_id": "<string>",
          "company_name": "<string>",
          "country": "<string>",
          "created_at": "<string>",
          "house_number": "<string>",
          "id": "<string>",
          "is_default": true,
          "name": "<string>",
          "phone": "<string>",
          "postal_code": "<string>",
          "shipping_type": "<string>",
          "state_province": "<string>",
          "street_address": "<string>",
          "updated_at": "<string>"
        }
      ],
      "comment": "<string>",
      "contact_name": "<string>",
      "created_at": "<string>",
      "credit_check": true,
      "custom_fields": {},
      "customer_groups": [
        {
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>"
        }
      ],
      "email": "<string>",
      "external_ref": "<string>",
      "files": [
        {
          "app_id": "<string>",
          "content_type": "<string>",
          "created_at": "<string>",
          "custom_fields": {},
          "filename": "<string>",
          "id": "<string>",
          "updated_at": "<string>",
          "url": "<string>"
        }
      ],
      "id": "<string>",
      "invoice_email": "<string>",
      "level": "<string>",
      "name": "<string>",
      "organisation_number": "<string>",
      "parent_id": "<string>",
      "phone": "<string>",
      "role": "<string>",
      "role_name": "<string>",
      "shipping_address": [
        {
          "city": "<string>",
          "co_address": "<string>",
          "company_id": "<string>",
          "company_name": "<string>",
          "country": "<string>",
          "created_at": "<string>",
          "house_number": "<string>",
          "id": "<string>",
          "is_default": true,
          "name": "<string>",
          "phone": "<string>",
          "postal_code": "<string>",
          "shipping_type": "<string>",
          "state_province": "<string>",
          "street_address": "<string>",
          "updated_at": "<string>"
        }
      ],
      "status": "<string>",
      "store_groups": [
        {
          "country_of_sale": "<string>",
          "created_at": "<string>",
          "description": "<string>",
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>",
          "store_type": "<string>",
          "updated_at": "<string>"
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "key": "<string>",
          "name": "<string>"
        }
      ],
      "tax_id_vat_number": "<string>",
      "updated_at": "<string>"
    }
  ],
  "phone_number": "<string>",
  "status": "<string>",
  "store_group": "<string>",
  "store_group_id": "<string>",
  "tags": [
    {
      "id": "<string>",
      "key": "<string>",
      "name": "<string>"
    }
  ],
  "updated_at": "<string>"
}

Path Parameters

​
app_id
string
required

uuid of the app

​
user_id
string
required

uuid of the user

Body

application/json

User update data

​
allow_email_notifications
boolean
​
allow_phone_notifications
boolean
​
allow_postal_notifications
boolean
​
city
string
​
country
string
​
country_code
string
​
first_name
string
​
language
string
​
last_name
string
​
market
string
​
phone_number
string
​
postal_code
string
​
status
enum<string>
Available options:
active,
inactive,
pending
​
store_group
string
​
street
string

Response

Updated user object

​
additions
object
​
address
object
​
app_id
string
​
attributes
object[]
​
communication_preferences
object
​
created_at
string
​
customer_groups
object[]
​
email
string
​
email_verified
boolean
​
files
object[]
​
first_name
string
​
id
string
​
is_super_admin
boolean
​
language
string
​
last_login_at
string
​
last_name
string
​
market
string
​
market_currency
string
​
market_id
string
​
organisations
object[]
​
phone_number
string
​
status
string
​
store_group
string
​
store_group_id
string
​
tags
object[]
​
updated_at
string