Change a delivery partner

PATCH

/delivery-partners/{id}

curl --request PATCH \
  --url https://example.com/delivery-partners/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "name": "example", "email": "hello@example.com" }'

Its name and email address.

Authorizations

• sessionCookie
  rounds:write
• apiKey
  rounds:write

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 200 characters

email

string | null format: email

<= 320 characters

Example ^generated

{
  "name": "example",
  "email": "hello@example.com"
}

Responses

200

Changed

Media typeapplication/json

object

id

required

UUID v7

string format: uuid

name

required

string

email

required

string | null

archivedAt

required

string | null format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "name": "Hilltop Gas"
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, without the permission this needs, or on a plan without delivery partners

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Not found

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Refused, with the reason

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

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"
    }
  ]
}