Skip to main content
POST
/
api
/
organizations
/
members
cURL
curl --request POST \
  --url https://api.recoupable.dev/api/organizations/members \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com"
}
'
{
  "status": "success",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Body

application/json

Member-organization association parameters

​
organizationId
string<uuid>
required

The account ID of the organization

​
accountId
string<uuid>

The account ID of the member to add. Provide exactly one of accountId or email.

​
email
string<email>

Email of the member to add. The account is created if it does not exist yet. Provide exactly one of accountId or email.

Response

Member added to organization successfully (or already a member)

​
status
enum<string>
required

Status of the request

Available options:
success
​
id
string<uuid>
required

UUID of the membership record

​
account_id
string<uuid>
required

The account ID of the member (resolved from email when email was provided)