Update your account details

patch

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

Changes only the fields you send; read-only fields cannot be changed.
A customer account must keep a phone number.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_id

string

required

ID of your byrd account (UUID); any other account answers 404.

Body Params

firstName

string

required

First name of the account holder.

lastName

string

required

Last name of the account holder.

companyName

string | null

Name of your company; null when not set.

senderName

string | null

Sender name printed on shipping labels instead of the company name; null when not set.

vatNumber

string | null

VAT number of your company; null when not set.

eoriNumber

string | null

EORI number of your company, used on export customs documents; null when not set.

phone

string | null

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

Phone number of your company: digits, spaces and + ( ) / - only. Required: it may be printed on shipping labels.

string

required

Email address you log in to the dashboard with.

billingEmail

string | null

Email address invoices are sent to; null when not set.

sendTrackingEmails

boolean

required

Whether byrd sends the recipients of your shipments a tracking email after the shipment is sent.

billingAddress

object

Billing address of your company. Send the complete address: it replaces the stored one rather than being merged into it.

codIBAN

string | null

IBAN of the bank account cash-on-delivery amounts are paid out to; null when not set.

codBIC

string | null

BIC of the bank account cash-on-delivery amounts are paid out to; null when not set.

userDefaults

object

Free-form JSON object with your dashboard preferences. An update replaces the whole object.

language

string | null

enum

Preferred language of the dashboard; null when not set.

en: English
de: German
pl: Polish
fr: French
it: Italian
es: Spanish

Allowed:

addressValidationEnabled

boolean

Whether byrd validates the destination address of your shipments before releasing them. Pickup shipments are never validated.

economyFallbackEnabled

boolean

Whether an economy shipment is sent with standard shipping when no economy service is available for it. Does not apply to B2B shipments.

defaultShipmentService

string

enum

Shipping service applied to shipments you create without naming one. B2B and pallet shipments always start with standard. Defaults to standard.

economy: cheapest, slower delivery
standard: regular delivery
express: faster delivery, picked with higher priority

Allowed:

partialFulfillmentEnabled

boolean

Whether byrd tries to split a shipment when one or more of its SKUs are out of stock.

b2bPalletEnabled

boolean

Whether you can create B2B shipments sent on pallets.

fallbackPhoneEnabled

boolean

Whether your phone number is used on shipping labels when the recipient has no phone number. Defaults to true.

blockedShipmentRetryEnabled

boolean

Whether shipments that could not be released for lack of stock are released again automatically, oldest first, once the stock is replenished. Defaults to false.

ioss

string | null

Import One-Stop Shop (IOSS) number used for customs declarations; null when not set. Set it to null to stop it being sent.

ukims

string | null

UK Internal Market Scheme (UKIMS) number used for customs declarations; null when not set. Set it to null to stop it being sent.

notificationConfig

object | null

Settings of the daily report email; null when never configured.

Headers

string

enum

Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:

Responses

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.