Browse the docs

Update a service

PATCH/api/v1/services/{id}

Needs an API key, and runs with the access of the member who made the key.
Send an Idempotency-Key. The same key with the same request within 24 hours gives the first answer again and changes nothing.
A connected AI assistant can use it too, as updateService.

Parameters

In the address

idstring (uuid)required

Headers

Idempotency-Keystringrequired
Unique user-scoped key for safely retrying this mutation for 24 hours.
At least 1 character. Up to 200 characters.

Request body

Sent as application/json.

serviceobjectrequired
Fields(8)
- lock_versioninteger
  At least 0.
- namestring
- descriptionstring or null
- unit_namestring
- unit_price_centsinteger (int64)
  Integer minor currency units, such as pence.
  At least 0.
- tax_rate_basis_pointsinteger
  At least 0. At most 10000.
- tax_inclusiveboolean
- activeboolean

Responses

200Service details.

dataobjectrequired
Fields(12)
- lock_versioninteger
  At least 0.
- created_atstring (date-time)required
- updated_atstring (date-time)required
- idstring (uuid)required
- account_idstring (uuid)required
- namestringrequired
- descriptionstring or null
- unit_namestringrequired
- unit_price_centsinteger (int64)required
  Integer minor currency units, such as pence.
  At least 0.
- tax_rate_basis_pointsintegerrequired
  At least 0. At most 10000.
- tax_inclusivebooleanrequired
- activebooleanrequired

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl -X PATCH "https://app.tradesender.co.uk/api/v1/services/b4ccc05f-b1ed-5dcd-bede-4479c3500345" \
  -H "Authorization: Bearer $TRADESENDER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "service": {
    "description": "Cut and shaped, with the cuttings taken away."
  }
}'