Organizations
Update an existing organization
Updates an existing organization’s basic details, contact information, and addresses. Only provided fields will be updated (partial update). Addresses can be added, modified, or removed.
PATCH
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
organisations
/
{org_id}
Error
A valid request URL is required to generate request examples{
"data": {
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"billing_address": [
{
"city": "<string>",
"co_address": "<string>",
"company_id": "<string>",
"company_name": "<string>",
"country": "<string>",
"created_at": "<string>",
"house_number": "<string>",
"id": "<string>",
"is_default": true,
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state_province": "<string>",
"street_address": "<string>",
"updated_at": "<string>"
}
],
"comment": "<string>",
"contact_name": "<string>",
"created_at": "<string>",
"credit_check": true,
"custom_fields": {},
"customer_groups": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>"
}
],
"email": "<string>",
"external_ref": "<string>",
"id": "<string>",
"invoice_email": "<string>",
"name": "<string>",
"organisation_number": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"shipping_address": [
{
"city": "<string>",
"co_address": "<string>",
"company_id": "<string>",
"company_name": "<string>",
"country": "<string>",
"created_at": "<string>",
"house_number": "<string>",
"id": "<string>",
"is_default": true,
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state_province": "<string>",
"street_address": "<string>",
"updated_at": "<string>"
}
],
"status": "<string>",
"tags": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"schedules": [
{
"add_category_names": [
"<string>"
],
"add_collection_names": [
"<string>"
],
"add_tag_names": [
"<string>"
],
"execute_at": "<string>",
"finished_at": "<string>",
"group_id": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_name": "<string>",
"item_type": "<string>",
"remove_category_names": [
"<string>"
],
"remove_collection_names": [
"<string>"
],
"remove_tag_names": [
"<string>"
],
"to_amount_cents_with_tax": 123,
"to_market_id": "<string>",
"to_market_status": "<string>",
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_start_sale_timestamp": "<string>",
"to_status": "<string>",
"to_stop_sale_timestamp": "<string>",
"to_store_group_id": "<string>"
}
],
"source_app_id": "<string>",
"source_id": "<string>",
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"tax_id_vat_number": "<string>",
"updated_at": "<string>",
"users": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"custom_role_id": "<string>",
"custom_role_name": "<string>",
"custom_role_slug": "<string>",
"email": "<string>",
"email_verified": true,
"id": "<string>",
"language": "<string>",
"level": "<string>",
"market": "<string>",
"name": "<string>",
"phone_number": "<string>",
"store_group": "<string>",
"surname": "<string>",
"updated_at": "<string>"
}
]
},
"details": [
"<string>"
],
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}Path Parameters
App slug
Team slug
Organization ID
Body
application/json
Updated organization details
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
active, pending, inactive Previous
Add address restriction for userAdds a user restriction to a specific organization address. This prevents the specified merchant user from accessing the given address within the organization.
Next
⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"billing_address": [
{
"city": "<string>",
"co_address": "<string>",
"company_id": "<string>",
"company_name": "<string>",
"country": "<string>",
"created_at": "<string>",
"house_number": "<string>",
"id": "<string>",
"is_default": true,
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state_province": "<string>",
"street_address": "<string>",
"updated_at": "<string>"
}
],
"comment": "<string>",
"contact_name": "<string>",
"created_at": "<string>",
"credit_check": true,
"custom_fields": {},
"customer_groups": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>"
}
],
"email": "<string>",
"external_ref": "<string>",
"id": "<string>",
"invoice_email": "<string>",
"name": "<string>",
"organisation_number": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"shipping_address": [
{
"city": "<string>",
"co_address": "<string>",
"company_id": "<string>",
"company_name": "<string>",
"country": "<string>",
"created_at": "<string>",
"house_number": "<string>",
"id": "<string>",
"is_default": true,
"name": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"state_province": "<string>",
"street_address": "<string>",
"updated_at": "<string>"
}
],
"status": "<string>",
"tags": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"schedules": [
{
"add_category_names": [
"<string>"
],
"add_collection_names": [
"<string>"
],
"add_tag_names": [
"<string>"
],
"execute_at": "<string>",
"finished_at": "<string>",
"group_id": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_name": "<string>",
"item_type": "<string>",
"remove_category_names": [
"<string>"
],
"remove_collection_names": [
"<string>"
],
"remove_tag_names": [
"<string>"
],
"to_amount_cents_with_tax": 123,
"to_market_id": "<string>",
"to_market_status": "<string>",
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_start_sale_timestamp": "<string>",
"to_status": "<string>",
"to_stop_sale_timestamp": "<string>",
"to_store_group_id": "<string>"
}
],
"source_app_id": "<string>",
"source_id": "<string>",
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"tax_id_vat_number": "<string>",
"updated_at": "<string>",
"users": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"custom_role_id": "<string>",
"custom_role_name": "<string>",
"custom_role_slug": "<string>",
"email": "<string>",
"email_verified": true,
"id": "<string>",
"language": "<string>",
"level": "<string>",
"market": "<string>",
"name": "<string>",
"phone_number": "<string>",
"store_group": "<string>",
"surname": "<string>",
"updated_at": "<string>"
}
]
},
"details": [
"<string>"
],
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}