Substy Developers
Account and agency

Request account action

Request a sensitive account change: manage emails, change password, connect or unlink a sign-in provider, revoke a session, or delete the account. Supply the action kind and its matching payload. Returns an actionId and a verification URL for the user; check get_account_action_status afterwards. Passwords and verification codes belong only in the verification page.

POST/v1/agencies/{agencyId}/account/actions

Request a sensitive account change: manage emails, change password, connect or unlink a sign-in provider, revoke a session, or delete the account. Supply the action kind and its matching payload. Returns an actionId and a verification URL for the user; check get_account_action_status afterwards. Passwords and verification codes belong only in the verification page.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agencies/string/account/actions" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "kind": "set_primary_email",    "payload": {      "emailId": "string"    }  }'
{  "data": {    "actionId": "string",    "status": "PENDING",    "authorizationUrl": "string",    "expiresAt": "string"  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Set account profile image PUT

Replace the authenticated user’s profile image with base64 PNG or JPEG file bytes and the matching contentType. Maximum decoded file size is 10 MiB. Returns the updated account profile.

Get account action status GET

Check an actionId returned by request_account_action after the user completes verification. Returns its status, expiry and recorded outcome. PENDING or RUNNING does not confirm the requested account change; an expired action requires a new request.