Skip to main content
POST
Deactivate a supplier
Only organization admins can deactivate a supplier. Deactivating a supplier that is already DEACTIVATED succeeds and changes nothing. To bring a supplier back, use POST /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate. Answers the supplier as it is after the change. The request has no body: if your HTTP client sends Content-Type: application/json, send {}.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the supplier belongs to.

Format: UUID

supplierId
string<uuid>
required

ID of the supplier (id in the supplier list).

Format: UUID

Response

Successful response

A supplier of the organization: someone you pay.

id
string
required

ID of the supplier.

Example:

"5f0c7d2a-91b4-4e6f-8a13-c2d4e6f80b17"

realm
string<uuid>
required

ID of the realm the supplier belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organization
string<uuid>
required

ID of the organization the supplier belongs to.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

name
string
required

Name of the supplier.

Example:

"Transportadora Boa Viagem Ltda"

document
string
required

CPF or CNPJ of the supplier, with no punctuation. A CNPJ with letters is returned in upper case.

Example:

"11222333000181"

documentType
enum<string>
required

CPF when the supplier is a person, CNPJ when it is a company.

Available options:
CPF,
CNPJ
Example:

"CNPJ"

email
string
required

E-mail address of the supplier.

Example:

"financeiro@boaviagem.example.com"

phoneNumber
string
required

Phone number of the supplier in international format.

Example:

"+5534984325252"

status
enum<string>
required

ACTIVE, or DEACTIVATED once the supplier was deactivated.

Available options:
ACTIVE,
DEACTIVATED
Example:

"DEACTIVATED"

tradingName
string

Trade name of the supplier. Absent when none was given.

Example:

"Boa Viagem Transportes"

address
object

Address of the supplier.

pixKey
string

PIX key to pay the supplier. Absent when none was given.

Example:

"financeiro@boaviagem.example.com"

pixKeyType
enum<string>

Type of pixKey: PHONE, EMAIL, CPF, CNPJ or EVP (a random key). Absent when there is no PIX key.

Available options:
PHONE,
EMAIL,
CPF,
CNPJ,
EVP
Example:

"EMAIL"

createdBy
string<uuid>

ID of the user who registered the supplier.

Example:

"e3553bc1-5e20-4e17-b22a-a796fda0aa99"

createdAt
string<date-time>

When the supplier was registered.

Example:

"2026-10-02T14:03:11.000Z"

updatedAt
string<date-time>

When the supplier was last changed.

Example:

"2026-10-05T09:30:00.000Z"