Skip to main content
PATCH
Update entity country activation

Overview

Sets the operational activation status for one country on a merchant entity. This does not modify entity profile data β€” use GET /entities/{id} to re-fetch the dossier after activation. On every real status change, Gu1 emits the entity.country_activation_changed webhook to subscribed endpoints. Transitions between statuses are free-form (any status may move to any other). Supported countryCode values: AR, BR, CL, CO, MX, US (case-insensitive).

Endpoint

Authentication

Requires entities:edit (legacy fallback: entities:write).

Path Parameters

string
required
UUID of the entity (merchant).
string
required
ISO 3166-1 alpha-2 country to update (AR, BR, CL, CO, MX, US).

Request Body

string
required
One of: deactivated, activation_requested, activation_in_progress, activated.

Response

Example

Webhook payload (on change)

When changed is true, subscribers receive:

Errors