Skip to content
API reference/Site members

Add a member

Try it

Adds someone as an approved member (or approves them, if they had asked). With send_link, they're emailed a one-time sign-in link in the business's name.

POST/api/v1/sites/{site_id}/members

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the members:write scope — approve, add and remove site members; mark pages members only (live at once).

members:writeChanges the live siteIdempotency-Key requiredMCP tool: add_site_member

Parameters

Named placeholders go in the path; the rest in a JSON body.

site_idstringPath · required
The site's id.1 to 100 characters
namestringBody · required
2 to 120 characters
emailstringBody · required
At most 200 characters
send_linkbooleanBody · optional
Email them a sign-in link now.Default true

Response

201 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X POST 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/members' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Marcus Webb","email":"marcus@example.com","send_link":true}'
Example arguments
{
  "site_id": "SITE_ID",
  "name": "Marcus Webb",
  "email": "marcus@example.com",
  "send_link": true
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "approved"
      ],
      "description": "pending = asked to join, waiting for approval; approved = may sign in."
    },
    "added_by": {
      "type": "string",
      "enum": [
        "visitor",
        "business"
      ]
    },
    "approved_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "last_sign_in_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "created_at": {
      "type": "string"
    },
    "is_sample": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "name",
    "email",
    "status",
    "added_by",
    "approved_at",
    "last_sign_in_at",
    "created_at",
    "is_sample"
  ],
  "additionalProperties": false
}