Skip to content

Update a supplier

PATCH
/suppliers/{id}
curl --request PATCH \
--url https://app.dev.buildtrace.eu/api/suppliers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "contact": "example", "notes": "example" }'

Edit a supplier’s name, contact and notes (the code is fixed). Omitted fields are left as they are; an empty contact or notes clears it.

Required scope: suppliers:write.

id
required
string format: uuid
Media typeapplication/json
object
name
string
contact

An empty string clears the contact.

string
notes

An empty string clears the notes.

string

Example generated

{
"name": "example",
"contact": "example",
"notes": "example"
}

Updated

Media typeapplication/json
object
id
required
string format: uuid
code
required
string
name
required
string
contact
string
notes
string
active
required
boolean

Example generated

{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"code": "example",
"name": "example",
"contact": "example",
"notes": "example",
"active": true
}

Invalid (blank name)

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}

Unauthorized

Not found