Cria uma campanha em rascunho
curl --request POST \
--url https://api.weve.cx/v1/clubs/{clubId}/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"text": "<string>",
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
],
"audience": {
"include": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"exclude": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
}
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/campaigns"
payload = {
"name": "<string>",
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"text": "<string>",
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
],
"audience": {
"include": {
"delivery_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"cohort_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"product_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"completed_course_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"exclude": {
"delivery_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"cohort_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"product_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"completed_course_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
}
}
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({
name: '<string>',
subject: '<string>',
preheader: '<string>',
reply_to: '<string>',
blocks: [
{
text: '<string>',
url: '<string>',
media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
alt: '<string>'
}
],
audience: {
include: {
delivery_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
cohort_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
completed_course_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
exclude: {
delivery_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
cohort_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
completed_course_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
}
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/campaigns', 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.weve.cx/v1/clubs/{clubId}/campaigns",
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([
'name' => '<string>',
'subject' => '<string>',
'preheader' => '<string>',
'reply_to' => '<string>',
'blocks' => [
[
'text' => '<string>',
'url' => '<string>',
'media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'alt' => '<string>'
]
],
'audience' => [
'include' => [
'delivery_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'cohort_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'product_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'completed_course_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'exclude' => [
'delivery_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'cohort_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'product_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'completed_course_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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.weve.cx/v1/clubs/{clubId}/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"preheader\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"blocks\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"alt\": \"<string>\"\n }\n ],\n \"audience\": {\n \"include\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"exclude\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n }\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.weve.cx/v1/clubs/{clubId}/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"preheader\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"blocks\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"alt\": \"<string>\"\n }\n ],\n \"audience\": {\n \"include\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"exclude\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/campaigns")
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 \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"preheader\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"blocks\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"alt\": \"<string>\"\n }\n ],\n \"audience\": {\n \"include\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"exclude\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"subject": "<string>",
"preheader": "<string>",
"blocks": [
{
"kind": "heading",
"text": "<string>",
"level": 1,
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
],
"audience": {
"include": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"exclude": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"reply_to": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"summary": {
"recipients": 123,
"sent": 123,
"opened": 123,
"clicked": 123
},
"stats": {
"total": 123,
"pending": 123,
"sending": 123,
"sent": 123,
"failed": 123,
"suppressed": 123,
"unreachable": 123,
"canceled": 123,
"delivered": 123,
"bounced": 123,
"complained": 123,
"opened": 123,
"clicked": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Campanhas
Criar campanha
Nasce em rascunho; só o nome é obrigatório, e o conteúdo completo só é exigido ao agendar.
POST
/
v1
/
clubs
/
{clubId}
/
campaigns
Cria uma campanha em rascunho
curl --request POST \
--url https://api.weve.cx/v1/clubs/{clubId}/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"text": "<string>",
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
],
"audience": {
"include": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"exclude": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
}
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/campaigns"
payload = {
"name": "<string>",
"subject": "<string>",
"preheader": "<string>",
"reply_to": "<string>",
"blocks": [
{
"text": "<string>",
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
],
"audience": {
"include": {
"delivery_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"cohort_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"product_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"completed_course_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"exclude": {
"delivery_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"cohort_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"product_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"completed_course_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
}
}
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({
name: '<string>',
subject: '<string>',
preheader: '<string>',
reply_to: '<string>',
blocks: [
{
text: '<string>',
url: '<string>',
media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
alt: '<string>'
}
],
audience: {
include: {
delivery_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
cohort_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
completed_course_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
exclude: {
delivery_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
cohort_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
product_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
completed_course_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
}
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/campaigns', 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.weve.cx/v1/clubs/{clubId}/campaigns",
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([
'name' => '<string>',
'subject' => '<string>',
'preheader' => '<string>',
'reply_to' => '<string>',
'blocks' => [
[
'text' => '<string>',
'url' => '<string>',
'media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'alt' => '<string>'
]
],
'audience' => [
'include' => [
'delivery_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'cohort_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'product_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'completed_course_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'exclude' => [
'delivery_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'cohort_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'product_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'completed_course_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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.weve.cx/v1/clubs/{clubId}/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"preheader\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"blocks\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"alt\": \"<string>\"\n }\n ],\n \"audience\": {\n \"include\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"exclude\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n }\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.weve.cx/v1/clubs/{clubId}/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"preheader\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"blocks\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"alt\": \"<string>\"\n }\n ],\n \"audience\": {\n \"include\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"exclude\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/campaigns")
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 \"name\": \"<string>\",\n \"subject\": \"<string>\",\n \"preheader\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"blocks\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"alt\": \"<string>\"\n }\n ],\n \"audience\": {\n \"include\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"exclude\": {\n \"delivery_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"cohort_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"product_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"completed_course_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"subject": "<string>",
"preheader": "<string>",
"blocks": [
{
"kind": "heading",
"text": "<string>",
"level": 1,
"url": "<string>",
"media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt": "<string>"
}
],
"audience": {
"include": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"exclude": {
"delivery_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"cohort_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"completed_course_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"reply_to": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"summary": {
"recipients": 123,
"sent": 123,
"opened": 123,
"clicked": 123
},
"stats": {
"total": 123,
"pending": 123,
"sending": 123,
"sent": 123,
"failed": 123,
"suppressed": 123,
"unreachable": 123,
"canceled": 123,
"delivered": 123,
"bounced": 123,
"complained": 123,
"opened": 123,
"clicked": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Token OPACO de sessão de quem administra, emitido por
/v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo
desenho do studentSession, para a outra identidade.
É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
studentSession; uma rota consumida pelos dois declara os dois
esquemas, e o middleware aceita qualquer um deles. As duas credenciais
são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
que cada uma existe.
O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
Authorization a cada chamada.
Path Parameters
Id público da organização — o mesmo que GET /v1/me devolve em
organization_id.
Na URL o recurso se chama club; no contrato e no domínio, organization.
A divergência é deliberada: clubs é a palavra do produto, e a URL é o que
as pessoas leem.
É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.
O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.
Body
application/json
Required string length:
1 - 120Maximum string length:
200Maximum string length:
200Maximum string length:
254Maximum array length:
50Show child attributes
Show child attributes
Quem recebe. Sem nenhuma regra de inclusão, é o club inteiro; com regras, é quem casa com QUALQUER uma delas. A exclusão tira quem casa com qualquer regra dela. Um id que deixou de existir não casa com ninguém — a audiência nunca se alarga sozinha.
Show child attributes
Show child attributes
Response
A campanha criada
Show child attributes
Show child attributes