Exchange one-time token for desktop connection

POST

/wp-json/wp2/studio-sync/v1/desktop/connect

curl --request POST \
  --url https://example.com/wp-json/wp2/studio-sync/v1/desktop/connect \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Public exchange of a one-time admin token for a permanent WP2Studio connection: access_token, connection_id, site mode. Rate limit 20 requests per minute per IP. Returns 201.

Request Body^required

Media typeapplication/json

object

token

required

Secret (magic-link, Studio, form, or connect).

string

client_name

Desktop client name. Default WP2 Studio.

string

default: WP2 Studio

device_id

Stable Studio device id.

string

Example

{
  "token": "example"
}

Responses

201

Connection and access token

Media typeapplication/json

object

success

Success flag (often Studio/License envelope).

boolean

instance_url

WordPress instance URL.

string

admin_url

Wp-admin URL.

string

mode

Mode (connection, replace, or pack).

string

connection_id

Studio Sync connection id.

string

user

Current user object, or null for a guest.

object

access_token

Permanent Studio Sync Bearer token.

string

expires_at

Token expiry; desktop connect currently returns null.

nullable

Example^generated

{
  "success": true,
  "instance_url": "example",
  "admin_url": "example",
  "mode": "example",
  "connection_id": "example",
  "user": {},
  "access_token": "example",
  "expires_at": "example"
}

400

Studio_sync_missing_token

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

401

Studio_sync_token_invalid

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

409

Studio_sync_token_used

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

410

Studio_sync_token_expired

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

429

Studio_sync_rate_limited

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

500

Studio_sync_user_not_found

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}