Send an Availability Link

Send one staff member their link, so they can set their usual week themselves. The response also returns the link, so you can share it another way.

Endpoint

POST /v1/staff/{staffId}/availability-link

Authentication

Requires an API key with the staff:write scope. Limited to 30 calls a minute.

Path Parameters

Parameter	Type	Description
staffId	integer	Staff member ID

Request Body

Parameter	Type	Required	Description
email	boolean	No	Send by email. Default true. Skipped when the staff member has no email address.
text	boolean	No	Send by text. Default true. Skipped when the staff member has no phone number or your account has no texting set up.

Response

Success (200 OK)

{
  "data": {
    "url": "https://app.equipdash.com/my-hours/AbC123dEf456",
    "sent": true,
    "request_id": 45
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-09-28T09:00:00+00:00"
  }
}

Field	Type	Description
url	string	The staff member's link. The same link every time, until you make a new one in the portal.
sent	boolean	false when neither an email nor a text could go out (no email address and no phone number, for example). The link is still returned.
request_id	integer	ID of the ask. The staff member counts as answered once they save their week.

Errors

Status	Code	Description
401	authentication_required	No API key provided
401	invalid_api_key	Invalid API key
403	insufficient_scope	API key lacks the staff:write scope
404	resource_not_found	No staff member with that ID in your account
422	validation_error	email or text is not a boolean
422	availability_link_not_sent	Both email and text were false ("Choose email, text, or both."), or the staff member no longer works for you
429	-	More than 30 calls in a minute. Wait a minute and try again.

Example Request

curl -X POST "https://app.equipdash.com/api/v1/staff/123/availability-link" \
  -H "Authorization: Bearer eqd_live_abc123xyz789..." \
  -H "Content-Type: application/json" \
  -d '{ "email": true, "text": false }'