Synq Docs
Management APIInvites

Invite someone

Emails them a link, single-use and valid 7 days, to join with a role (at most the caller's own permissions; never owner). They accept it signed in at Synq with that email. Needs `org.members.edit`. Recorded as `invite.created`.

POST/v1/orgs/{org}/invites

Emails them a link, single-use and valid 7 days, to join with a role (at most the caller's own permissions; never owner). They accept it signed in at Synq with that email. Needs org.members.edit. Recorded as invite.created.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "role": "string"  }'
{  "id": "string",  "email": "string",  "role": "string",  "invited_by": "string",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Accept an invite POST

As the person it was sent to: signed in at Synq with that email, verified. Recorded as `invite.accepted` and `member.added`.

Remove a member DELETE

Not the owner. Needs `org.members.edit`. Recorded as `member.removed`.