Update user account's details.

patch

https://api.getbyrd.com/v2/users/{user_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_id

string

required

Body Params

firstName

string

required

lastName

string

required

companyName

string | null

senderName

string | null

vatNumber

string | null

eoriNumber

string | null

phone

string | null

^[0-9+()/ -]*$

string

required

billingEmail

string | null

sendTrackingEmails

boolean

required

codIBAN

string | null

codBIC

string | null

userDefaults

object

language

string | null

enum

Allowed:

addressValidationEnabled

boolean

economyFallbackEnabled

boolean

defaultShipmentService

string

enum

Allowed:

partialFulfillmentEnabled

boolean

b2bPalletEnabled

boolean

fallbackPhoneEnabled

boolean

blockedShipmentRetryEnabled

boolean

ioss

string | null

ukims

string | null

notificationConfig

object,null | NestedUserNotificationConfigSchema_20999527

Headers

string

enum

Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.byrd.customer+json

application/json

200Success response to a valid request

400Generic error response

401The request changed a field the caller's role may not write - isStaff, v3CarrierSelector or status. The offending field is named in extra.field.

403Generic error response

422The request mentioned isDemo, which is set when the account is created and cannot be changed afterwards.