Data Requests
Update a data request
Also accepts PUT. Pass schedule_attributes to attach a new schedule or modify the existing one; pass schedule_attributes._destroy=true to cancel it.
Sending recipients_attributes emails the request again to every recipient when it is not a template, has no pending schedule, was not sent from a template, and has open inputs. Requires the read:project and write:data_request token scopes.
PATCH
/
projects
/
{project_id}
/
data_requests
/
{id}
Update a data request
curl --request PATCH \
--url https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"data_request": {
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"message": "<string>",
"inputs_attributes": [
{
"id": 123,
"nexus_event_type_id": 123,
"_destroy": true
}
],
"recipients_attributes": [
{
"id": 123,
"user_id": 123,
"email": "jsmith@example.com",
"recipient_type": "to",
"_destroy": true
}
],
"schedule_attributes": {
"next_execution_at": "2023-11-07T05:31:56Z",
"end_date": "2023-12-25",
"max_occurrences": 2,
"_destroy": true
}
}
}
'import requests
url = "https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}"
payload = { "data_request": {
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"message": "<string>",
"inputs_attributes": [
{
"id": 123,
"nexus_event_type_id": 123,
"_destroy": True
}
],
"recipients_attributes": [
{
"id": 123,
"user_id": 123,
"email": "jsmith@example.com",
"recipient_type": "to",
"_destroy": True
}
],
"schedule_attributes": {
"next_execution_at": "2023-11-07T05:31:56Z",
"end_date": "2023-12-25",
"max_occurrences": 2,
"_destroy": True
}
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data_request: {
name: '<string>',
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
message: '<string>',
inputs_attributes: [{id: 123, nexus_event_type_id: 123, _destroy: true}],
recipients_attributes: [
{
id: 123,
user_id: 123,
email: 'jsmith@example.com',
recipient_type: 'to',
_destroy: true
}
],
schedule_attributes: {
next_execution_at: '2023-11-07T05:31:56Z',
end_date: '2023-12-25',
max_occurrences: 2,
_destroy: true
}
}
})
};
fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}', 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://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data_request' => [
'name' => '<string>',
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'message' => '<string>',
'inputs_attributes' => [
[
'id' => 123,
'nexus_event_type_id' => 123,
'_destroy' => true
]
],
'recipients_attributes' => [
[
'id' => 123,
'user_id' => 123,
'email' => 'jsmith@example.com',
'recipient_type' => 'to',
'_destroy' => true
]
],
'schedule_attributes' => [
'next_execution_at' => '2023-11-07T05:31:56Z',
'end_date' => '2023-12-25',
'max_occurrences' => 2,
'_destroy' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}"
payload := strings.NewReader("{\n \"data_request\": {\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"message\": \"<string>\",\n \"inputs_attributes\": [\n {\n \"id\": 123,\n \"nexus_event_type_id\": 123,\n \"_destroy\": true\n }\n ],\n \"recipients_attributes\": [\n {\n \"id\": 123,\n \"user_id\": 123,\n \"email\": \"jsmith@example.com\",\n \"recipient_type\": \"to\",\n \"_destroy\": true\n }\n ],\n \"schedule_attributes\": {\n \"next_execution_at\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-12-25\",\n \"max_occurrences\": 2,\n \"_destroy\": true\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data_request\": {\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"message\": \"<string>\",\n \"inputs_attributes\": [\n {\n \"id\": 123,\n \"nexus_event_type_id\": 123,\n \"_destroy\": true\n }\n ],\n \"recipients_attributes\": [\n {\n \"id\": 123,\n \"user_id\": 123,\n \"email\": \"jsmith@example.com\",\n \"recipient_type\": \"to\",\n \"_destroy\": true\n }\n ],\n \"schedule_attributes\": {\n \"next_execution_at\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-12-25\",\n \"max_occurrences\": 2,\n \"_destroy\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data_request\": {\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"message\": \"<string>\",\n \"inputs_attributes\": [\n {\n \"id\": 123,\n \"nexus_event_type_id\": 123,\n \"_destroy\": true\n }\n ],\n \"recipients_attributes\": [\n {\n \"id\": 123,\n \"user_id\": 123,\n \"email\": \"jsmith@example.com\",\n \"recipient_type\": \"to\",\n \"_destroy\": true\n }\n ],\n \"schedule_attributes\": {\n \"next_execution_at\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-12-25\",\n \"max_occurrences\": 2,\n \"_destroy\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "req_AaBbCcDdEeFfGgHh",
"name": "<string>",
"role": "sendable",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"url": "https://app.gomangrove.com/nexus/data_requests/SIGNED_ID",
"template_id": "req_AaBbCcDdEeFfGgHh",
"recurring_schedule_friendly_id": "<string>",
"schedule": {
"id": "sch_AaBbCcDdEeFfGgHh",
"status": "active",
"recurrence_rule": {
"type": "daily",
"interval": 2
},
"starts_at": "2023-11-07T05:31:56Z",
"next_execution_at": "2023-11-07T05:31:56Z",
"last_executed_at": "2023-11-07T05:31:56Z",
"end_condition": "never",
"end_date": "2023-12-25",
"max_occurrences": 123,
"execution_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Path Parameters
The project's friendly ID (e.g. prj_aBcD1234eFgH5678).
The data request's friendly ID (e.g. req_AaBbCcDdEeFfGgHh).
Pattern:
^req_[A-Za-z0-9]{16}$Body
application/json
start_time and end_time are required unless the request is a template (it has a recurring schedule). A request needs at least one entry in inputs_attributes.
Show child attributes
Show child attributes
Response
OK
Example:
"req_AaBbCcDdEeFfGgHh"
template for a request with a recurring schedule, which sends a copy on each run; otherwise sendable.
Available options:
sendable, template When the request email was first sent, or null.
The submission link sent to recipients. Anyone holding it can submit data without signing in, so treat it as a secret.
Example:
"https://app.gomangrove.com/nexus/data_requests/SIGNED_ID"
The friendly ID of the template this request was sent from, if any.
Example:
"req_AaBbCcDdEeFfGgHh"
The friendly ID of the recurring schedule that sent this request, if any.
The attached schedule, or null when there is none.
Show child attributes
Show child attributes
⌘I
Update a data request
curl --request PATCH \
--url https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"data_request": {
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"message": "<string>",
"inputs_attributes": [
{
"id": 123,
"nexus_event_type_id": 123,
"_destroy": true
}
],
"recipients_attributes": [
{
"id": 123,
"user_id": 123,
"email": "jsmith@example.com",
"recipient_type": "to",
"_destroy": true
}
],
"schedule_attributes": {
"next_execution_at": "2023-11-07T05:31:56Z",
"end_date": "2023-12-25",
"max_occurrences": 2,
"_destroy": true
}
}
}
'import requests
url = "https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}"
payload = { "data_request": {
"name": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"message": "<string>",
"inputs_attributes": [
{
"id": 123,
"nexus_event_type_id": 123,
"_destroy": True
}
],
"recipients_attributes": [
{
"id": 123,
"user_id": 123,
"email": "jsmith@example.com",
"recipient_type": "to",
"_destroy": True
}
],
"schedule_attributes": {
"next_execution_at": "2023-11-07T05:31:56Z",
"end_date": "2023-12-25",
"max_occurrences": 2,
"_destroy": True
}
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data_request: {
name: '<string>',
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
message: '<string>',
inputs_attributes: [{id: 123, nexus_event_type_id: 123, _destroy: true}],
recipients_attributes: [
{
id: 123,
user_id: 123,
email: 'jsmith@example.com',
recipient_type: 'to',
_destroy: true
}
],
schedule_attributes: {
next_execution_at: '2023-11-07T05:31:56Z',
end_date: '2023-12-25',
max_occurrences: 2,
_destroy: true
}
}
})
};
fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}', 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://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data_request' => [
'name' => '<string>',
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'message' => '<string>',
'inputs_attributes' => [
[
'id' => 123,
'nexus_event_type_id' => 123,
'_destroy' => true
]
],
'recipients_attributes' => [
[
'id' => 123,
'user_id' => 123,
'email' => 'jsmith@example.com',
'recipient_type' => 'to',
'_destroy' => true
]
],
'schedule_attributes' => [
'next_execution_at' => '2023-11-07T05:31:56Z',
'end_date' => '2023-12-25',
'max_occurrences' => 2,
'_destroy' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}"
payload := strings.NewReader("{\n \"data_request\": {\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"message\": \"<string>\",\n \"inputs_attributes\": [\n {\n \"id\": 123,\n \"nexus_event_type_id\": 123,\n \"_destroy\": true\n }\n ],\n \"recipients_attributes\": [\n {\n \"id\": 123,\n \"user_id\": 123,\n \"email\": \"jsmith@example.com\",\n \"recipient_type\": \"to\",\n \"_destroy\": true\n }\n ],\n \"schedule_attributes\": {\n \"next_execution_at\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-12-25\",\n \"max_occurrences\": 2,\n \"_destroy\": true\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data_request\": {\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"message\": \"<string>\",\n \"inputs_attributes\": [\n {\n \"id\": 123,\n \"nexus_event_type_id\": 123,\n \"_destroy\": true\n }\n ],\n \"recipients_attributes\": [\n {\n \"id\": 123,\n \"user_id\": 123,\n \"email\": \"jsmith@example.com\",\n \"recipient_type\": \"to\",\n \"_destroy\": true\n }\n ],\n \"schedule_attributes\": {\n \"next_execution_at\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-12-25\",\n \"max_occurrences\": 2,\n \"_destroy\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data_request\": {\n \"name\": \"<string>\",\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"message\": \"<string>\",\n \"inputs_attributes\": [\n {\n \"id\": 123,\n \"nexus_event_type_id\": 123,\n \"_destroy\": true\n }\n ],\n \"recipients_attributes\": [\n {\n \"id\": 123,\n \"user_id\": 123,\n \"email\": \"jsmith@example.com\",\n \"recipient_type\": \"to\",\n \"_destroy\": true\n }\n ],\n \"schedule_attributes\": {\n \"next_execution_at\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-12-25\",\n \"max_occurrences\": 2,\n \"_destroy\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "req_AaBbCcDdEeFfGgHh",
"name": "<string>",
"role": "sendable",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"sent_at": "2023-11-07T05:31:56Z",
"message": "<string>",
"url": "https://app.gomangrove.com/nexus/data_requests/SIGNED_ID",
"template_id": "req_AaBbCcDdEeFfGgHh",
"recurring_schedule_friendly_id": "<string>",
"schedule": {
"id": "sch_AaBbCcDdEeFfGgHh",
"status": "active",
"recurrence_rule": {
"type": "daily",
"interval": 2
},
"starts_at": "2023-11-07T05:31:56Z",
"next_execution_at": "2023-11-07T05:31:56Z",
"last_executed_at": "2023-11-07T05:31:56Z",
"end_condition": "never",
"end_date": "2023-12-25",
"max_occurrences": 123,
"execution_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}