VTvtex
Account

Add an account holder

Changed on

Adds a new account holder to the customer credit account. This new user can share the account's credit limit with users already registered on the account.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Credit ControlMainMain Access
Credit ControlChecking AccountsCreate Checking Accounts

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/api/creditcontrol/accounts/{creditAccountId}/holders

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/holders
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

creditAccountIdstring required
Example:01bce461-9g03-12ds-8217-b3d39271e15b

Credit account identification.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

Example request

{
  "claims": {
    "email": "email@domain.com"
  }
}

Response

OK

levelnumber required

Holder hierarchy. The value 2 indicates that the holder is a dependent of the account's main holder.

idstring required

Holder identification.

createdAtstring required

Date of appointment of the holder.

Changes

  • 0cfe5b381175Revision changes
    • warning

      the optional response header Connection removed for the status 200

    • warning

      the optional response header Content-Length removed for the status 200

    • warning

      the optional response header Date removed for the status 200

    • warning

      the optional response header Server removed for the status 200

    • warning

      the optional response header X-CDNIgnore removed for the status 200

    • warning

      the optional response header X-Powered-by-VTEX-Janus-Edge removed for the status 200

    • warning

      the optional response header X-Track removed for the status 200

    • warning

      the optional response header X-Translate removed for the status 200

    • warning

      the optional response header X-Translate-BackEnd removed for the status 200

    • warning

      the optional response header X-VTEX-Janus-Router-Backend-App removed for the status 200

  • c8735f67eb83Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      the request property default value email@domain.com was removed

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status