curl --request POST \
--url https://api.quiva.ai/records/member-send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"space_id": "<string>",
"folder": "<string>",
"round_id": "<string>",
"step": "<string>",
"title": "<string>",
"round_config": "<string>",
"description": "<string>",
"priority": "<string>",
"metadata": {},
"forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"folder_forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"create_missing": true,
"reset": [
"<string>"
],
"sent_field": "<string>",
"unsent_only": true,
"dry_run": true,
"retry_failed": true,
"remind": true
}
'import requests
url = "https://api.quiva.ai/records/member-send"
payload = {
"space_id": "<string>",
"folder": "<string>",
"round_id": "<string>",
"step": "<string>",
"title": "<string>",
"round_config": "<string>",
"description": "<string>",
"priority": "<string>",
"metadata": {},
"forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"folder_forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"create_missing": True,
"reset": ["<string>"],
"sent_field": "<string>",
"unsent_only": True,
"dry_run": True,
"retry_failed": True,
"remind": True
}
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({
space_id: '<string>',
folder: '<string>',
round_id: '<string>',
step: '<string>',
title: '<string>',
round_config: '<string>',
description: '<string>',
priority: '<string>',
metadata: {},
forms: [
{
config_id: '<string>',
label: '<string>',
form_id: '<string>',
done_field: '<string>'
}
],
folder_forms: [
{
config_id: '<string>',
label: '<string>',
form_id: '<string>',
done_field: '<string>'
}
],
create_missing: true,
reset: ['<string>'],
sent_field: '<string>',
unsent_only: true,
dry_run: true,
retry_failed: true,
remind: true
})
};
fetch('https://api.quiva.ai/records/member-send', 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.quiva.ai/records/member-send",
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([
'space_id' => '<string>',
'folder' => '<string>',
'round_id' => '<string>',
'step' => '<string>',
'title' => '<string>',
'round_config' => '<string>',
'description' => '<string>',
'priority' => '<string>',
'metadata' => [
],
'forms' => [
[
'config_id' => '<string>',
'label' => '<string>',
'form_id' => '<string>',
'done_field' => '<string>'
]
],
'folder_forms' => [
[
'config_id' => '<string>',
'label' => '<string>',
'form_id' => '<string>',
'done_field' => '<string>'
]
],
'create_missing' => true,
'reset' => [
'<string>'
],
'sent_field' => '<string>',
'unsent_only' => true,
'dry_run' => true,
'retry_failed' => true,
'remind' => true
]),
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.quiva.ai/records/member-send"
payload := strings.NewReader("{\n \"space_id\": \"<string>\",\n \"folder\": \"<string>\",\n \"round_id\": \"<string>\",\n \"step\": \"<string>\",\n \"title\": \"<string>\",\n \"round_config\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"metadata\": {},\n \"forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"folder_forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"create_missing\": true,\n \"reset\": [\n \"<string>\"\n ],\n \"sent_field\": \"<string>\",\n \"unsent_only\": true,\n \"dry_run\": true,\n \"retry_failed\": true,\n \"remind\": true\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.quiva.ai/records/member-send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"space_id\": \"<string>\",\n \"folder\": \"<string>\",\n \"round_id\": \"<string>\",\n \"step\": \"<string>\",\n \"title\": \"<string>\",\n \"round_config\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"metadata\": {},\n \"forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"folder_forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"create_missing\": true,\n \"reset\": [\n \"<string>\"\n ],\n \"sent_field\": \"<string>\",\n \"unsent_only\": true,\n \"dry_run\": true,\n \"retry_failed\": true,\n \"remind\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quiva.ai/records/member-send")
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 \"space_id\": \"<string>\",\n \"folder\": \"<string>\",\n \"round_id\": \"<string>\",\n \"step\": \"<string>\",\n \"title\": \"<string>\",\n \"round_config\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"metadata\": {},\n \"forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"folder_forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"create_missing\": true,\n \"reset\": [\n \"<string>\"\n ],\n \"sent_field\": \"<string>\",\n \"unsent_only\": true,\n \"dry_run\": true,\n \"retry_failed\": true,\n \"remind\": true\n}"
response = http.request(request)
puts response.read_body{
"status_code": 123,
"body": {}
}{
"status_code": 400,
"body": {
"error": "field 'rating' is required"
}
}Send a members step to every member
Sends a journey members step to every member filed under a folder, as a background job over pages of members. For each member it makes or reuses a client login, upserts a task keyed by round, step and member, adds one action per form, gets or makes the member’s rows, empties reset fields, stamps sent_field and invites any login it made. Every step is safe to repeat, and a repeat reopens the task and its actions. Starting the same round, step and folder again resumes a stopped job; a finished one starts a fresh pass. retry_failed resumes an unfinished pass, then runs the failed members again. dry_run starts a preview job that counts members, new logins and members without an email, with a paged row per member. remind starts a reminder job over the members the send reached: it skips members who are done or were reminded in the last 24 hours and notifies the rest with title as the message. Every job answers its status, whose id reads it back. Staff only.
curl --request POST \
--url https://api.quiva.ai/records/member-send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"space_id": "<string>",
"folder": "<string>",
"round_id": "<string>",
"step": "<string>",
"title": "<string>",
"round_config": "<string>",
"description": "<string>",
"priority": "<string>",
"metadata": {},
"forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"folder_forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"create_missing": true,
"reset": [
"<string>"
],
"sent_field": "<string>",
"unsent_only": true,
"dry_run": true,
"retry_failed": true,
"remind": true
}
'import requests
url = "https://api.quiva.ai/records/member-send"
payload = {
"space_id": "<string>",
"folder": "<string>",
"round_id": "<string>",
"step": "<string>",
"title": "<string>",
"round_config": "<string>",
"description": "<string>",
"priority": "<string>",
"metadata": {},
"forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"folder_forms": [
{
"config_id": "<string>",
"label": "<string>",
"form_id": "<string>",
"done_field": "<string>"
}
],
"create_missing": True,
"reset": ["<string>"],
"sent_field": "<string>",
"unsent_only": True,
"dry_run": True,
"retry_failed": True,
"remind": True
}
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({
space_id: '<string>',
folder: '<string>',
round_id: '<string>',
step: '<string>',
title: '<string>',
round_config: '<string>',
description: '<string>',
priority: '<string>',
metadata: {},
forms: [
{
config_id: '<string>',
label: '<string>',
form_id: '<string>',
done_field: '<string>'
}
],
folder_forms: [
{
config_id: '<string>',
label: '<string>',
form_id: '<string>',
done_field: '<string>'
}
],
create_missing: true,
reset: ['<string>'],
sent_field: '<string>',
unsent_only: true,
dry_run: true,
retry_failed: true,
remind: true
})
};
fetch('https://api.quiva.ai/records/member-send', 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.quiva.ai/records/member-send",
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([
'space_id' => '<string>',
'folder' => '<string>',
'round_id' => '<string>',
'step' => '<string>',
'title' => '<string>',
'round_config' => '<string>',
'description' => '<string>',
'priority' => '<string>',
'metadata' => [
],
'forms' => [
[
'config_id' => '<string>',
'label' => '<string>',
'form_id' => '<string>',
'done_field' => '<string>'
]
],
'folder_forms' => [
[
'config_id' => '<string>',
'label' => '<string>',
'form_id' => '<string>',
'done_field' => '<string>'
]
],
'create_missing' => true,
'reset' => [
'<string>'
],
'sent_field' => '<string>',
'unsent_only' => true,
'dry_run' => true,
'retry_failed' => true,
'remind' => true
]),
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.quiva.ai/records/member-send"
payload := strings.NewReader("{\n \"space_id\": \"<string>\",\n \"folder\": \"<string>\",\n \"round_id\": \"<string>\",\n \"step\": \"<string>\",\n \"title\": \"<string>\",\n \"round_config\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"metadata\": {},\n \"forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"folder_forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"create_missing\": true,\n \"reset\": [\n \"<string>\"\n ],\n \"sent_field\": \"<string>\",\n \"unsent_only\": true,\n \"dry_run\": true,\n \"retry_failed\": true,\n \"remind\": true\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.quiva.ai/records/member-send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"space_id\": \"<string>\",\n \"folder\": \"<string>\",\n \"round_id\": \"<string>\",\n \"step\": \"<string>\",\n \"title\": \"<string>\",\n \"round_config\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"metadata\": {},\n \"forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"folder_forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"create_missing\": true,\n \"reset\": [\n \"<string>\"\n ],\n \"sent_field\": \"<string>\",\n \"unsent_only\": true,\n \"dry_run\": true,\n \"retry_failed\": true,\n \"remind\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quiva.ai/records/member-send")
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 \"space_id\": \"<string>\",\n \"folder\": \"<string>\",\n \"round_id\": \"<string>\",\n \"step\": \"<string>\",\n \"title\": \"<string>\",\n \"round_config\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"metadata\": {},\n \"forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"folder_forms\": [\n {\n \"config_id\": \"<string>\",\n \"label\": \"<string>\",\n \"form_id\": \"<string>\",\n \"done_field\": \"<string>\"\n }\n ],\n \"create_missing\": true,\n \"reset\": [\n \"<string>\"\n ],\n \"sent_field\": \"<string>\",\n \"unsent_only\": true,\n \"dry_run\": true,\n \"retry_failed\": true,\n \"remind\": true\n}"
response = http.request(request)
puts response.read_body{
"status_code": 123,
"body": {}
}{
"status_code": 400,
"body": {
"error": "field 'rating' is required"
}
}