> ## Documentation Index
> Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Activate a customer

> Sets a customer's `status` to `ACTIVE`.

Only a `DEACTIVATED` customer can be activated: activating one that is already `ACTIVE` is rejected. To deactivate a customer, use `POST /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate`.

Answers the customer as it is after the change. The request has no body: if your HTTP client sends `Content-Type: application/json`, send `{}`.


## OpenAPI

````yaml /api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate
openapi: 3.0.3
info:
  title: Registry
  version: 1.0.0
  description: >-
    Portão 3 registry API. Every endpoint requires a bearer token in the
    Authorization header (Authorization: Bearer <token>) unless its page states
    otherwise; see the Authentication guide. That requirement is not repeated
    per endpoint. Generated by tools/openapi from code (routes + security) and
    the hand-written spec (request/response bodies). Confidence tiers:
    generated:typed=37 copied:manual=0 unknown=0.
servers:
  - url: https://api.registry.v2.portao3.com.br/
    description: production
  - url: https://api.registry.dev.3pers.com.br/
    description: development
security: []
tags:
  - name: Customers
  - name: Companies
  - name: People
  - name: Products
  - name: Suppliers
paths:
  /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate:
    post:
      tags:
        - Customers
      summary: Activate a customer
      description: Sets a customer's `status` to `ACTIVE`.
      operationId: >-
        postRealmsByRealmIdOrganizationsByOrganizationIdCustomerByCustomerIdActivate
      parameters:
        - name: realmId
          in: path
          required: true
          description: |-
            ID of your realm.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
        - name: organizationId
          in: path
          required: true
          description: |-
            ID of the organization the customer belongs to.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
        - name: customerId
          in: path
          required: true
          description: |-
            ID of the customer.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: 7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the customer.
                    example: 7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13
                    format: uuid
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                        description: Street name.
                        example: Rua das Flores
                      number:
                        type: string
                        description: Street number (letters, digits and dashes).
                        example: '123'
                      complement:
                        type: string
                        description: Extra address detail, such as an apartment or suite.
                        example: Apto 45
                      neighborhood:
                        type: string
                        description: Neighborhood.
                        example: Centro
                      city:
                        type: string
                        description: City.
                        example: São Paulo
                      state:
                        type: string
                        description: Two-letter code of the Brazilian state.
                        example: SP
                      postalCode:
                        type: string
                        description: Postal code (CEP), as `00000-000`.
                        example: 01000-000
                    description: Postal address of the customer.
                    example:
                      street: Rua das Flores
                      number: '123'
                      complement: Apto 45
                      neighborhood: Centro
                      city: São Paulo
                      state: SP
                      postalCode: 01000-000
                  name:
                    type: string
                    description: >-
                      Name of the customer: a person's full name or a company's
                      name.
                    example: Ana Souza
                  document:
                    type: string
                    description: >-
                      Tax ID of the customer, without formatting: a CPF (11
                      digits) or a CNPJ (14 characters — the first 12 may be
                      uppercase letters, the last 2 are digits).
                    example: '52998224725'
                  documentType:
                    type: string
                    description: >-
                      Kind of `document`: `CPF` for 11 characters, `CNPJ`
                      otherwise.
                    example: CPF
                  trandingName:
                    type: string
                    description: Trade name of a company customer.
                    example: Souza Studio
                  email:
                    type: string
                    description: E-mail address of the customer.
                    example: ana.souza@example.com
                  phoneNumber:
                    type: string
                    description: >-
                      Phone number of the customer, in international format: `+`
                      followed by digits. A few older records that could not be
                      converted to this format are returned exactly as they were
                      stored.
                    example: '+5511999999999'
                  createdAt:
                    type: string
                    format: date-time
                    description: When the customer was created.
                    example: '2026-03-14T12:30:00.000Z'
                  createdBy:
                    type: string
                    description: >-
                      ID of the user or API client that created the customer.
                      The customer list does not include it.
                    example: 9b2f4c1e-5d38-4a76-b0e1-3c8a7d2f6e45
                  hash:
                    type: string
                    description: >-
                      Token that identifies the customer in the link of their
                      portal page (`customerUrl`).
                    example: c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f
                    format: uuid
                  customerUrl:
                    type: string
                    description: >-
                      Link to the customer's portal page. It is built from the
                      portal address and `hash`.
                    example: >-
                      https://portal.example.com/c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f
                  status:
                    type: string
                    description: 'Status of the customer: `ACTIVE` or `DEACTIVATED`.'
                    example: ACTIVE
                  customFields:
                    description: >-
                      Values of the organization's custom fields for this
                      customer, keyed by the field's `slug`. Absent, or `null`,
                      when the customer has none.


                      ---


                      Example: `{"cost-center":"CC-1020"}`
                    example:
                      cost-center: CC-1020
                    type: object
                    additionalProperties: {}
                    nullable: true
                required:
                  - id
                  - documentType
                  - customerUrl
                description: 'A customer: the person or company an organization bills.'
        '400':
          description: >-
            `ACTIVATE_CUSTOMER_BUSINESS_LOGIC` — The customer is already
            `ACTIVE`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - ACTIVATE_CUSTOMER_BUSINESS_LOGIC
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: ACTIVATE_CUSTOMER_BUSINESS_LOGIC
                origin: REGISTRY
                message: This customer is alredy activate.
        '403':
          description: '`FORBIDDEN_CUSTOMER` — You do not belong to the organization.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - FORBIDDEN_CUSTOMER
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: FORBIDDEN_CUSTOMER
                origin: REGISTRY
                message: >-
                  You do not have permission to perform this action on this
                  resource (customer)
        '404':
          description: >-
            `CUSTOMER_NOT_FOUND` — No customer with this ID exists in the
            organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - CUSTOMER_NOT_FOUND
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: CUSTOMER_NOT_FOUND
                origin: REGISTRY
                message: Customer not found
        '422':
          description: >-
            `BAD_REQUEST` — A path parameter is not valid, such as a
            `customerId` that is not a UUID; `fields` lists each one.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - BAD_REQUEST
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - REGISTRY
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                  fields:
                    type: array
                    description: >-
                      One entry per invalid request field (validation errors
                      only).
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: >-
                            Path of the invalid field, e.g. `label` or
                            `values[0].value`.
                          example: label
                        message:
                          type: string
                          description: Why the field was rejected.
                          example: label is required
                        code:
                          type: string
                          description: >-
                            `<FIELD>_<REASON>` — e.g. `LABEL_REQUIRED`,
                            `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.
                          example: LABEL_REQUIRED
                        values:
                          type: array
                          items:
                            type: string
                          description: >-
                            The accepted values, when the field is an
                            enumeration.
                      required:
                        - field
                        - message
                        - code
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: BAD_REQUEST
                origin: REGISTRY
                message: >-
                  Bad Request: Your request is invalid or incomplete. Please
                  make sure you are requesting with the right fields.
                fields:
                  - field: customerId
                    message: Invalid UUID
                    code: CUSTOMERID_UUID

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.