PATCH
/
account
curl --request PATCH \
  --url https://api.truecold.io/v1/account \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "code": "25-BCN-XA43N",
  "image": "https://public-assets.s3.eu-central-1.amazonaws.com/assets/truecold.png",
  "owner_id": "382bc9c0-6a3b-4255-97f4-98e91ceab047",
  "name": "TrueCold",
  "cif": "B46215744",
  "city": "Barcelona",
  "country": "Spain",
  "fiscal_name": "Truecold Inc.",
  "head_quarter_account_id": "382bc9c0-6a3b-4255-97f4-98e91ceab047",
  "is_head_quarter": true,
  "state": true,
  "street": true
}'
{
  "error": false,
  "data": {
    "id": "<string>",
    "created_at": "<string>",
    "code": "<string>",
    "image": "<string>",
    "updated_at": "<string>",
    "owner_id": "<string>",
    "name": "<string>",
    "role": "<string>",
    "cif": "<string>",
    "city": "<string>",
    "country": "<string>",
    "fiscal_name": "<string>",
    "head_quarter_account_id": "<string>",
    "is_head_quarter": true,
    "state": "<string>",
    "street": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
code
string

String that represents the internal shipment code

Example:

"25-BCN-XA43N"

​
image
string

Absolute URL of the image

Example:

"https://public-assets.s3.eu-central-1.amazonaws.com/assets/truecold.png"

​
owner_id
string

User UUID that will become the owner of the account

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
name
string

Public name of the account

Example:

"TrueCold"

​
cif
string

VAT number of the account

Example:

"B46215744"

​
city
string

City where the account is located

Example:

"Barcelona"

​
country
string

Country where the account is located

Example:

"Spain"

​
fiscal_name
string

Fiscal name of the account

Example:

"Truecold Inc."

​
head_quarter_account_id
string

UUID of the account that will be the head quarter of the current account

Example:

"382bc9c0-6a3b-4255-97f4-98e91ceab047"

​
is_head_quarter
boolean

If true, the account will be considered as the head quarter of the company

Example:

true

​
state
string

State where the account is located.

Example:

true

​
street
string

Street address where the account is located.

Example:

true

Response

200
application/json
​
error
boolean
Example:

false

​
data
object