Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Upsert organisation address restrictions

Bulk-upserts organisation address user restrictions.

PUT/api/v2/{team_slug}/{app_slug}/organisations/address-restrictions
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
team_slugstringrequired
app_slugstringrequired
Request body
requiredapplication/json
address_restrictionsOrganisationAddressRestrictionItem[]required
min items 1 · max items 20
Show properties
Array of OrganisationAddressRestrictionItem
organisation_idUUIDrequired
address_idUUIDrequired
user_idUUIDrequired
Responses
200

OK (partial success possible)

dataOrganisationAddressRestriction[]required
Show properties
Array of OrganisationAddressRestriction
organisation_idUUIDrequired
address_idUUIDrequired
user_idUUIDrequired
errorsOrganisationLinkError[]required
Show properties
Array of OrganisationLinkError
organisation_idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
namestring | null
idUUID | null
Show properties
Any of:
UUID
string<uuid>
null
null
messagestringrequired
400

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
401

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
403

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
500

Request-level failure

errorErrorBodyrequired
Show properties
messagestringrequired
detailsstring[]required
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PUT 'https://api.enad.io/api/v2/string/string/organisations/address-restrictions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "address_restrictions": [
    {
      "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",
      "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
    }
  ]
}'
Response
{
  "data": [
    {
      "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",
      "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
    }
  ],
  "errors": [
    {
      "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",
      "name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}