Skip to main content
PUT
/
v1
/
orgs
/
{org_id}
/
members
/
invites
/
{identifier}
Invite or save a member
curl --request PUT \
  --url https://api.arklow.io/v1/orgs/{org_id}/members/invites/{identifier} \
  --header 'Content-Type: application/json' \
  --header 'x-arklow-auth: <api-key>' \
  --data '
{
  "permissions": [
    "owner"
  ]
}
'
{
  "data": {
    "action": "invited",
    "invite": {
      "id": "<string>",
      "org_id": "<string>",
      "init_permissions": [
        "owner"
      ],
      "user_id": "<string>",
      "email": "<string>"
    },
    "membership": {
      "id": "<string>",
      "org_id": "<string>",
      "user_id": "<string>",
      "permissions": [
        "owner"
      ],
      "email": "<string>"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

x-arklow-auth
string
header
required

Path Parameters

org_id
string
required

Organization identifier

Pattern: ^[0-9]+$
identifier
string
required

User identifier or email of the invitee

Minimum string length: 1

Body

application/json
permissions
enum<string>[]
Available options:
owner

Response

200 - application/json

Default Response

data
object
required
errors
object[] | null
required