Skip to content
Bottle

Change a contact at a supplier

PATCH
/stock/suppliers/{id}/contacts/{contactId}
curl --request PATCH \
  --url https://example.com/stock/suppliers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/contacts/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "name": "example", "jobTitle": "example", "phone": "example", "email": "", "note": "example", "isBilling": true, "forOrders": true, "forDeliveries": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

contactId
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 120 characters
jobTitle
string | null
<= 120 characters
phone
string | null
<= 40 characters
email
Any of:
string | null format: email
<= 254 characters
note
string | null
<= 500 characters
isBilling
boolean
forOrders
boolean
forDeliveries
boolean

Responses

Section titled “Responses”

200

Section titled “200”

The supplier, with its contacts

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
address
required
string | null
accountNumber
required
string | null
note
required
string | null
archivedAt
required
string | null format: date-time
yardIds
required
Array<string>
productIds
required
Array<string>
contacts
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
jobTitle
required
string | null
phone
required
string | null
email
required
string | null
note
required
string | null
isMain
required
boolean
isBilling
required
boolean
forOrders
required
boolean
forDeliveries
required
boolean
openOrders
required
integer
lastOrderedAt
required
string | null format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "yardIds": [
    "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  ],
  "productIds": [
    "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  ],
  "contacts": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

No such supplier or contact in this business

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}