Add a member

curl --request POST \
  --url https://api.kintra.io/api/v1/tenant/{tenantId}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '<string>'})
};

fetch('https://api.kintra.io/api/v1/tenant/{tenantId}/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kintra.io/api/v1/tenant/{tenantId}/members"

payload = { "email": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "id": "<string>",
    "roles": [
      {
        "role_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "username": "<string>"
  },
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "id": "<string>",
    "roles": [
      {
        "role_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "username": "<string>"
  },
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

Members

Add a member

Gives a person access to the Kintra CMS for your tenant. email and role are both required. A role of super_admin can manage everything under the tenant, members and API keys included; read_only can read members, API keys and the analytics summary and change nothing. An address that already holds a Kintra tenant account joins with that account; one that does not gets an account created and an email with a link to set a password. The response data carries the new membership. An address already a member of this tenant returns 409.

POST

tenant

{tenantId}

members

Add a member

curl --request POST \
  --url https://api.kintra.io/api/v1/tenant/{tenantId}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: '<string>'})
};

fetch('https://api.kintra.io/api/v1/tenant/{tenantId}/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kintra.io/api/v1/tenant/{tenantId}/members"

payload = { "email": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "id": "<string>",
    "roles": [
      {
        "role_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "username": "<string>"
  },
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "id": "<string>",
    "roles": [
      {
        "role_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "<string>",
    "tenant_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "user_id": "<string>",
    "username": "<string>"
  },
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "success": true,
  "data": null,
  "errors": [
    {
      "message": "<string>",
      "path": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Auth0 access token

Path Parameters

tenantId

string

required

Body

application/json

string

required

role

enum<string>

required

Portal operator roles that can be assigned to tenant members (not loyalty user).

Available options:

super_admin,

read_only

Response

success

boolean

required

data

object

Show child attributes

errors

object[]

Show child attributes

message

string

List members Remove a member

⌘I

Overview

Portal API

Gateway API

Add a member

Authorizations

Path Parameters

Body

Response