Add address restriction for user

Adds a user restriction to a specific organization address. This prevents the specified merchant user from accessing the given address within the organization.

POST/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/address/{address_id}

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/address/{address_id}

Adds a user restriction to a specific organization address. This prevents the specified merchant user from accessing the given address within the organization.

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: POST
Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/address/\{address_id\}
Summary: Add address restriction for user
Description: Adds a user restriction to a specific organization address. This prevents the specified merchant user from accessing the given address within the organization.
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters4 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	Application slug identifier
team_slug	path	Yes	string	Team slug identifier
org_id	path	Yes	string	Organization UUID
address_id	path	Yes	string	Address UUID

Request bodyDocumented body

Required: Yes
Description: Merchant user ID to restrict from this address
Content: application/json (object)

Input Address User Restriction

Property	Type	Required	Details
`merchant_user_id`	string	Yes	-

Generated example (synthetic):

{
  "merchant_user_id": "string"
}

Responses5 statuses

Status	Description	Content
200	User restriction added successfully	application/json (object)
400	Invalid request (e.g. bad payload, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
404	Organization, address, or user not found	application/json (object)
500	Internal server error	application/json (object)

200 - object

String Result

Property	Type	Required	Details
`data`	string	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Generated example (synthetic):

{
  "data": "string",
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

404 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: POST
Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/address/\{address_id\}
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Organizations
OpenAPI summary: Add address restriction for user