sam|nord Developers
samnord.com
Suppliers

PATCH /suppliers/{id}

Update a supplier relationship status. Requires suppliers.update permission. Only allows Active ↔ Inactive transitions.

Path parameters

Name Type Required Description
id string yes The unique identifier of the record

Request body

Required.

application/json

  • status string · required
{
    "status": "Active"
}

Responses

Status Description
200 A json object describing the updated supplier relationship
400 The request was rejected
403 The requesting user lacks appropriate permissions
422 Validation errors

Response 200 body

  • data object · required — When fields[] is not provided, all properties are returned. When fields[] is provided, only the requested properties are included.
  • meta object · required
{
    "data": {
        "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
        "businessId": "string",
        "businessName": "string",
        "createdAt": "2024-06-30T19:00:00Z",
        "createdBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "invitationId": "string",
        "invitedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "organizationId": "string",
        "status": "active",
        "updatedAt": "2024-06-30T19:00:00Z",
        "updatedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        }
    },
    "meta": {
        "requestId": "019a3a60-6328-7075-8a41-76ff545ca5d3",
        "userId": "019a3a60-929c-7820-9b35-bf79a8bf83a6",
        "organizationId": "019a3a60-8175-7a68-88da-ecb4a7040b86"
    }
}