Consume magic-link token

POST

/wp-json/wp2/magic-links/v1/consume

curl --request POST \
  --url https://example.com/wp-json/wp2/magic-links/v1/consume \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Publicly accepts a magic-link secret, logs the user in (no remember-me cookie), and consumes a single-use token. HTTPS is required.

Request Body

Media typeapplication/json

object

token

required

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

string

Example

{
  "token": "example"
}

Responses

200

Logged in

Media typeapplication/json

object

user

Current user object, or null for a guest.

object

id

Numeric entity id.

integer

displayName

Display name.

string

email

Email.

string

nicename

User nicename/slug.

string

nonce

Fresh wp_rest nonce for the next requests.

string

redirect

Redirect URL after login. Optional.

string

Example^generated

{
  "user": {
    "id": 1,
    "displayName": "example",
    "email": "example",
    "nicename": "example"
  },
  "nonce": "example",
  "redirect": "example"
}

400

Wp2platform_magic_ssl

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": {}
}

403

Wp2platform_magic_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": {}
}

429

Wp2platform_magic_rate

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": {}
}