Register volunteer at authorized partner kiosk

POST

/api/integrations/clock/register

curl --request POST \
  --url https://example.com/api/integrations/clock/register \
  --header 'Content-Type: application/json' \
  --header 'x-kiosk-secret: <x-kiosk-secret>' \
  --data '{ "phone": "+17045551234", "first_name": "Jane", "last_name": "Doe", "email": "jane.doe@example.com" }'

Authorizations

• KioskSecretAuth

Request Body^required

Media typeapplication/json

object

phone

required

string

Example

+17045551234

first_name

required

string

Example

Jane

last_name

string

nullable

Example

Doe

email

string format: email

nullable

Example

jane.doe@example.com

Responses

200

Volunteer registered successfully

Media typeapplication/json

object

user_id

required

string format: uuid

volunteer_name

required

string

phone

required

string

status

required

string

Allowed values: registered already_registered

Example

{
  "volunteer_name": "Jane Doe",
  "phone": "+17045551234",
  "status": "registered"
}

400

Bad request / Invalid input parameters

Media typeapplication/problem+json

RFC 7807 Problem Details for HTTP APIs

object

type

required

string

title

required

string

status

required

Current status of the record or process.

integer

detail

required

string

instance

string

retry_after

integer

Example

{
  "status": "IN_PROGRESS",
  "retry_after": 60
}

401

Authentication required or invalid credentials

Media typeapplication/problem+json

RFC 7807 Problem Details for HTTP APIs

object

type

required

string

title

required

string

status

required

Current status of the record or process.

integer

detail

required

string

instance

string

retry_after

integer

Example

{
  "status": "IN_PROGRESS",
  "retry_after": 60
}