Team

Invite someone by email

POST /v1/invitations

Emails a link to join with a role: it works once, for invitation_ttl_s (7 days), for a person signed in with that verified address (inviting it again re-sends it). Per account: max_members (50) people, max_open_invitations (25) waiting, invitations_per_day (25) emails a day. Free.

Auth: the dashboard session cookie.

Send an idempotency-key header to retry safely: the same key and body within 1 day never repeat the work.

Example

cURL
curl -X POST 'https://socialtap.dev/v1/invitations' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "email": "string"
}'

The dashboard's session cookie, not an API key.

idempotency-keystringmax 255 chars

On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state.

Body

application/json

JSON. Fields marked nullable may be null; optional ones may be left out.

emailstring

Who to invite. Inviting an address that has an invitation waiting sends it again, with a new link and this role.

role?string

The role they get. Default: member.

One ofadminmember

Response

application/json

201

Invite someone by email

dataobject
ShowHide 8 child fields
created_atstring date-time

When it was last sent, RFC 3339 UTC.

emailstring

The address invited: only a person signed in with this verified address can accept.

expires_atstring date-time

When its link stops working, RFC 3339 UTC.

idstring

Invitation ID (inv_…).

invited_bystringnullable

The address of the person who sent it; null when they are no longer a person here.

objectstring

Always invitation.

One ofinvitation

rolestring

The role they get when they accept.

One ofadminmember

statusstring

pending: its link works until expires_at. New values may be added.

One ofpendingacceptedrevokedexpired

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

409

409 Conflict.

A request with this Idempotency-Key is still running.

Retry after the seconds in the retry-after header to get that request's result.

422

422 Unprocessable.

This Idempotency-Key was already used for a different request (another route or body). Or it was used for this same request, which ran and returned a secret we no longer keep (details.reason answer_expired): running it again would create another.

Use a new Idempotency-Key for a different request, and reuse a key only to retry the identical request. With reason answer_expired, check what the first request created (GET /v1/api_keys, GET /v1/webhook_endpoints) before sending it again under a new key.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId invitations.create