Assign Seat

POST

customer-seats

Assign Seat

curl --request POST \
  --url https://api.getruba.com/v1/customer-seats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "external_customer_id": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_member_id": "<string>",
  "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "immediate_claim": false
}
'

import requests

url = "https://api.getruba.com/v1/customer-seats"

payload = {
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "external_customer_id": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_member_id": "<string>",
    "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "immediate_claim": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscription_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    email: 'jsmith@example.com',
    external_customer_id: '<string>',
    customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    external_member_id: '<string>',
    member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    metadata: {},
    immediate_claim: false
  })
};

fetch('https://api.getruba.com/v1/customer-seats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/customer-seats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscription_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'email' => 'jsmith@example.com',
    'external_customer_id' => '<string>',
    'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'external_member_id' => '<string>',
    'member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'metadata' => [
        
    ],
    'immediate_claim' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/customer-seats"

	payload := strings.NewReader("{\n  \"subscription_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"email\": \"jsmith@example.com\",\n  \"external_customer_id\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_member_id\": \"<string>\",\n  \"member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"immediate_claim\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getruba.com/v1/customer-seats")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscription_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"email\": \"jsmith@example.com\",\n  \"external_customer_id\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_member_id\": \"<string>\",\n  \"member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"immediate_claim\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/customer-seats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscription_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"email\": \"jsmith@example.com\",\n  \"external_customer_id\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_member_id\": \"<string>\",\n  \"member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"immediate_claim\": false\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "member": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "customer_id": "<string>",
    "email": "<string>",
    "name": "Jane Doe",
    "external_id": "usr_1337"
  },
  "email": "<string>",
  "customer_email": "<string>",
  "invitation_token_expires_at": "2023-11-07T05:31:56Z",
  "claimed_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z",
  "seat_metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Authentication: You can generate a Personal Access Token from your settings.

Body

application/json

subscription_id

string<uuid> | null

Subscription Id: Subscription ID. Required if neither order_id nor checkout_id is provided.

order_id

string<uuid> | null

Order Id: Order ID for one-time purchases. Required if subscription_id is not provided.

string<email> | null

Email: Email of the customer to assign the seat to.

external_customer_id

string | null

External Customer Id: External customer ID for the seat assignment.

customer_id

string<uuid> | null

Customer Id: Customer ID for the seat assignment.

external_member_id

string | null

External Member Id: External member ID for the seat assignment. Can be used alone (lookup existing member) or with email (create/validate member).

member_id

string<uuid> | null

Member Id: Member ID for the seat assignment.

metadata

Metadata · object | null

Metadata: Additional metadata for the seat (max 10 keys, 1KB total).

immediate_claim

boolean

default:false

Immediate Claim: If true, the seat will be immediately claimed without sending an invitation email. API-only feature.

Response

Request completed successfully

created_at

string<date-time>

required

The time Ruba created this record.

modified_at

string<date-time> | null

required

The time this record last changed.

string<uuid>

required

Id: Seat ID.

status

enum<string>

required

Status: Status of the seat.

Available options:

pending,

claimed,

revoked

subscription_id

string<uuid> | null

Subscription Id: Subscription ID (for recurring seats).

order_id

string<uuid> | null

Order Id: Order ID (for one-time purchase seats).

customer_id

string<uuid> | null

Customer Id: Customer ID. When member_model_enabled is true, this is the billing customer (purchaser). When false, this is the seat member customer.

member_id

string<uuid> | null

Member Id: Member ID of the seat occupant.

member

Member · object | null

Member: Member associated with this seat.

Show child attributes

string | null

Email: Email of the seat member (set when member_model_enabled is true).

customer_email

string | null

Customer Email: Assigned customer email.

invitation_token_expires_at

string<date-time> | null

Invitation Token Expires At: When the invitation token expires.

claimed_at

string<date-time> | null

Claimed At: When the seat was claimed.

revoked_at

string<date-time> | null

Revoked At: When the seat was revoked.

seat_metadata

Seat Metadata · object | null

Seat Metadata: Additional metadata for the seat.

Claim Seat### Intent Runs the claim seat action. ### When to call it Call this when your workflow reaches the point where it must claim seat. ### Access boundary Use the credential type and authentication scheme shown for this operation. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives.

⌘I

Assign Seat

curl --request POST \
  --url https://api.getruba.com/v1/customer-seats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "external_customer_id": "<string>",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_member_id": "<string>",
  "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "immediate_claim": false
}
'

import requests

url = "https://api.getruba.com/v1/customer-seats"

payload = {
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "external_customer_id": "<string>",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_member_id": "<string>",
    "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "immediate_claim": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subscription_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    order_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    email: 'jsmith@example.com',
    external_customer_id: '<string>',
    customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    external_member_id: '<string>',
    member_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    metadata: {},
    immediate_claim: false
  })
};

fetch('https://api.getruba.com/v1/customer-seats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getruba.com/v1/customer-seats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscription_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'order_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'email' => 'jsmith@example.com',
    'external_customer_id' => '<string>',
    'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'external_member_id' => '<string>',
    'member_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'metadata' => [
        
    ],
    'immediate_claim' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getruba.com/v1/customer-seats"

	payload := strings.NewReader("{\n  \"subscription_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"email\": \"jsmith@example.com\",\n  \"external_customer_id\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_member_id\": \"<string>\",\n  \"member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"immediate_claim\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getruba.com/v1/customer-seats")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscription_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"email\": \"jsmith@example.com\",\n  \"external_customer_id\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_member_id\": \"<string>\",\n  \"member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"immediate_claim\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getruba.com/v1/customer-seats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscription_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"order_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"email\": \"jsmith@example.com\",\n  \"external_customer_id\": \"<string>\",\n  \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"external_member_id\": \"<string>\",\n  \"member_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": {},\n  \"immediate_claim\": false\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "member": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "customer_id": "<string>",
    "email": "<string>",
    "name": "Jane Doe",
    "external_id": "usr_1337"
  },
  "email": "<string>",
  "customer_email": "<string>",
  "invitation_token_expires_at": "2023-11-07T05:31:56Z",
  "claimed_at": "2023-11-07T05:31:56Z",
  "revoked_at": "2023-11-07T05:31:56Z",
  "seat_metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Read This First

Create a Sale

Collect and Reconcile

Manage Recurring Revenue

Model Customer Access

Power the Customer Portal

Configure the Platform

React to State Changes

Intent

When to call it

Access boundary

Successful result

Authorizations

Body

Response