Skip to content
Tallyraydocs

Verify an email with a link's token; an invited user sets their password with it

POST
/v1/auth/verify-email
curl --request POST \
  --url https://example.com/v1/auth/verify-email \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example", "token": "example" }'

Who: anyone.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
password
required
string
token
required
string

Example generated

{
  "password": "example",
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time

Example 

{
  "created_by": {
    "kind": "user"
  },
  "status": "invited"
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}