GuidesAPI ReferenceChangelogDiscussions
Log In
API Reference

Grant a customer access to an address

post
https://ampere.chargee.io/api/v2/addresses//access
  • Permission: ADDRESS_MANAGEMENT
  • Roles: extended_user, flex_management

Connects an existing customer to this address at the given access level, naming them by the sub they were issued when registered with Chargee. The customer is looked up within your own realm, so a sub from another realm reports 404 rather than connecting. Repeating the request for a customer who already has access returns 409 rather than silently changing their role — use PATCH for that.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UUID of the address

Body Params
string
required

Identifier of the customer to grant access to — the sub they were issued when registered with Chargee. The customer must already exist in our directory; they are never created by this endpoint. The lookup is scoped to your own realm, so a sub belonging to another realm simply does not resolve.

string
enum
required

Access level to grant. Required — an omitted role is rejected rather than defaulted, so access level is always deliberate.

Allowed:
Responses

403

Forbidden — the caller's role lacks the required permission (ADDRESS_MANAGEMENT).

404

Address not found, or no such customer in this realm

409

This customer already has access to this address (ADDRESS_ACCESS_ALREADY_EXISTS)

502

The address service is unavailable or timed out. error is SERVICE_UNAVAILABLE.

Updated 13 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago

Did this page help you?