Post Login - HelpYouSponsor Docs

POST

frontend

{client_id}

{program_id}

{session_id}

Post Login

curl --request POST \
  --url https://api.helpyousponsor.com/v1/frontend/login/{client_id}/{program_id}/{session_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "password": "<string>"
}
'

{
  "message": "<string>",
  "donor": {},
  "client": {},
  "redirect": "<string>",
  "session_logged_in": true,
  "status": "success"
}

Path Parameters

client_id

integer

required

Client ID for the login

program_id

integer

required

Program ID for the login

session_id

string

required

Session ID for the login (optional)

Body

application/json

Username and Password for login

username

string

required

password

string<password>

required

Response

message

string

donor

object

client

object

redirect

string

session_logged_in

boolean

status

string

Example:

"success"

Post LogoutHandles user logout by terminating the session and clearing related data.

Post Login

curl --request POST \
  --url https://api.helpyousponsor.com/v1/frontend/login/{client_id}/{program_id}/{session_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "password": "<string>"
}
'

{
  "message": "<string>",
  "donor": {},
  "client": {},
  "redirect": "<string>",
  "session_logged_in": true,
  "status": "success"
}