Skip to main content

Update User Account by ID

PUT 
/v2/users/accounts/:id

Update an user account.

Request​

Path Parameters

    id stringrequired

    User account ID.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid stringrequired

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Body

required

Update user account payload.

    oneOf
    object

Responses​

User account updated.

Schema
    id objectrequired

    User account ID.

    state stringrequired

    Possible values: [pending, active, expired, deactivated, deleting]

    User state.

    created_at date-timerequired

    User created date.

    updated_at date-timerequired

    User updated date.

Loading...