Edit a program

PUT

program

{program_id}

Edit a program

curl --request PUT \
  --url https://api.helpyousponsor.com/v1/program/{program_id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "id": 3541,
  "client_id": "207",
  "hysform_id": 638,
  "donor_hysform_id": null,
  "setting_id": 410,
  "emailset_id": 1567,
  "entity_submit": null,
  "donor_submit": null,
  "link_id": null,
  "name": "adfdfs",
  "prefix": "fd",
  "counter": "0",
  "lft": 2,
  "rgt": 5,
  "tree": 207,
  "box_folder_id": null,
  "deleted_at": null,
  "created_at": "2023-11-23T17:14:06.000000Z",
  "updated_at": "2023-11-23T17:21:37.000000Z",
  "children": "[]",
  "user_id": 542,
  "program_id": 3541
}
'

import requests

url = "https://api.helpyousponsor.com/v1/program/{program_id}"

payload = {
    "id": 3541,
    "client_id": "207",
    "hysform_id": 638,
    "donor_hysform_id": None,
    "setting_id": 410,
    "emailset_id": 1567,
    "entity_submit": None,
    "donor_submit": None,
    "link_id": None,
    "name": "adfdfs",
    "prefix": "fd",
    "counter": "0",
    "lft": 2,
    "rgt": 5,
    "tree": 207,
    "box_folder_id": None,
    "deleted_at": None,
    "created_at": "2023-11-23T17:14:06.000000Z",
    "updated_at": "2023-11-23T17:21:37.000000Z",
    "children": "[]",
    "user_id": 542,
    "program_id": 3541
}
headers = {
    "X-HYS-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 3541,
    client_id: '207',
    hysform_id: 638,
    donor_hysform_id: null,
    setting_id: 410,
    emailset_id: 1567,
    entity_submit: null,
    donor_submit: null,
    link_id: null,
    name: 'adfdfs',
    prefix: 'fd',
    counter: '0',
    lft: 2,
    rgt: 5,
    tree: 207,
    box_folder_id: null,
    deleted_at: null,
    created_at: '2023-11-23T17:14:06.000000Z',
    updated_at: '2023-11-23T17:21:37.000000Z',
    children: '[]',
    user_id: 542,
    program_id: 3541
  })
};

fetch('https://api.helpyousponsor.com/v1/program/{program_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://api.helpyousponsor.com/v1/program/{program_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 3541,
    'client_id' => '207',
    'hysform_id' => 638,
    'donor_hysform_id' => null,
    'setting_id' => 410,
    'emailset_id' => 1567,
    'entity_submit' => null,
    'donor_submit' => null,
    'link_id' => null,
    'name' => 'adfdfs',
    'prefix' => 'fd',
    'counter' => '0',
    'lft' => 2,
    'rgt' => 5,
    'tree' => 207,
    'box_folder_id' => null,
    'deleted_at' => null,
    'created_at' => '2023-11-23T17:14:06.000000Z',
    'updated_at' => '2023-11-23T17:21:37.000000Z',
    'children' => '[]',
    'user_id' => 542,
    'program_id' => 3541
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-HYS-API-Key: <api-key>"
  ],
]);

$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.helpyousponsor.com/v1/program/{program_id}"

	payload := strings.NewReader("{\n  \"id\": 3541,\n  \"client_id\": \"207\",\n  \"hysform_id\": 638,\n  \"donor_hysform_id\": null,\n  \"setting_id\": 410,\n  \"emailset_id\": 1567,\n  \"entity_submit\": null,\n  \"donor_submit\": null,\n  \"link_id\": null,\n  \"name\": \"adfdfs\",\n  \"prefix\": \"fd\",\n  \"counter\": \"0\",\n  \"lft\": 2,\n  \"rgt\": 5,\n  \"tree\": 207,\n  \"box_folder_id\": null,\n  \"deleted_at\": null,\n  \"created_at\": \"2023-11-23T17:14:06.000000Z\",\n  \"updated_at\": \"2023-11-23T17:21:37.000000Z\",\n  \"children\": \"[]\",\n  \"user_id\": 542,\n  \"program_id\": 3541\n}")

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

	req.Header.Add("X-HYS-API-Key", "<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.put("https://api.helpyousponsor.com/v1/program/{program_id}")
  .header("X-HYS-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": 3541,\n  \"client_id\": \"207\",\n  \"hysform_id\": 638,\n  \"donor_hysform_id\": null,\n  \"setting_id\": 410,\n  \"emailset_id\": 1567,\n  \"entity_submit\": null,\n  \"donor_submit\": null,\n  \"link_id\": null,\n  \"name\": \"adfdfs\",\n  \"prefix\": \"fd\",\n  \"counter\": \"0\",\n  \"lft\": 2,\n  \"rgt\": 5,\n  \"tree\": 207,\n  \"box_folder_id\": null,\n  \"deleted_at\": null,\n  \"created_at\": \"2023-11-23T17:14:06.000000Z\",\n  \"updated_at\": \"2023-11-23T17:21:37.000000Z\",\n  \"children\": \"[]\",\n  \"user_id\": 542,\n  \"program_id\": 3541\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.helpyousponsor.com/v1/program/{program_id}")

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

request = Net::HTTP::Put.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": 3541,\n  \"client_id\": \"207\",\n  \"hysform_id\": 638,\n  \"donor_hysform_id\": null,\n  \"setting_id\": 410,\n  \"emailset_id\": 1567,\n  \"entity_submit\": null,\n  \"donor_submit\": null,\n  \"link_id\": null,\n  \"name\": \"adfdfs\",\n  \"prefix\": \"fd\",\n  \"counter\": \"0\",\n  \"lft\": 2,\n  \"rgt\": 5,\n  \"tree\": 207,\n  \"box_folder_id\": null,\n  \"deleted_at\": null,\n  \"created_at\": \"2023-11-23T17:14:06.000000Z\",\n  \"updated_at\": \"2023-11-23T17:21:37.000000Z\",\n  \"children\": \"[]\",\n  \"user_id\": 542,\n  \"program_id\": 3541\n}"

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

{
  "message": "Program info successfully updated."
}

{
  "message": "Validation error message"
}

Authorizations

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

Path Parameters

program_id

integer

required

The ID of the program to update

Body

application/json

Data to update a program

integer

The ID of the program

Example:

3541

client_id

string

The ID of the client

Example:

"207"

hysform_id

integer

The ID of the hysform

Example:

638

donor_hysform_id

integer

Example:

null

setting_id

integer

The ID of the setting

Example:

410

emailset_id

integer

Example:

1567

entity_submit

string

The entity submit

Example:

null

donor_submit

string

The donor submit

Example:

null

link_id

integer

The ID of the link

Example:

null

name

string

The name of the program

Example:

"adfdfs"

prefix

string

The prefix of the program

Example:

"fd"

counter

string

The counter of the program

Example:

"0"

lft

integer

The lft of the program

Example:

2

rgt

integer

The rgt of the program

Example:

5

tree

integer

The tree of the program

Example:

207

box_folder_id

integer

Example:

null

deleted_at

string

Example:

null

created_at

string

Example:

"2023-11-23T17:14:06.000000Z"

updated_at

string

Example:

"2023-11-23T17:21:37.000000Z"

children

integer[]

Example:

"[]"

user_id

integer

The ID of the user

Example:

542

program_id

integer

The ID of the program

Example:

3541

Response

Successful operation

message

string

Example:

"Program info successfully updated."

Get Detailed Field OptionsRetrieves detailed field options for a specific program and type, * including program information, fields, reports, and details.

Edit a program

curl --request PUT \
  --url https://api.helpyousponsor.com/v1/program/{program_id} \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "id": 3541,
  "client_id": "207",
  "hysform_id": 638,
  "donor_hysform_id": null,
  "setting_id": 410,
  "emailset_id": 1567,
  "entity_submit": null,
  "donor_submit": null,
  "link_id": null,
  "name": "adfdfs",
  "prefix": "fd",
  "counter": "0",
  "lft": 2,
  "rgt": 5,
  "tree": 207,
  "box_folder_id": null,
  "deleted_at": null,
  "created_at": "2023-11-23T17:14:06.000000Z",
  "updated_at": "2023-11-23T17:21:37.000000Z",
  "children": "[]",
  "user_id": 542,
  "program_id": 3541
}
'

import requests

url = "https://api.helpyousponsor.com/v1/program/{program_id}"

payload = {
    "id": 3541,
    "client_id": "207",
    "hysform_id": 638,
    "donor_hysform_id": None,
    "setting_id": 410,
    "emailset_id": 1567,
    "entity_submit": None,
    "donor_submit": None,
    "link_id": None,
    "name": "adfdfs",
    "prefix": "fd",
    "counter": "0",
    "lft": 2,
    "rgt": 5,
    "tree": 207,
    "box_folder_id": None,
    "deleted_at": None,
    "created_at": "2023-11-23T17:14:06.000000Z",
    "updated_at": "2023-11-23T17:21:37.000000Z",
    "children": "[]",
    "user_id": 542,
    "program_id": 3541
}
headers = {
    "X-HYS-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 3541,
    client_id: '207',
    hysform_id: 638,
    donor_hysform_id: null,
    setting_id: 410,
    emailset_id: 1567,
    entity_submit: null,
    donor_submit: null,
    link_id: null,
    name: 'adfdfs',
    prefix: 'fd',
    counter: '0',
    lft: 2,
    rgt: 5,
    tree: 207,
    box_folder_id: null,
    deleted_at: null,
    created_at: '2023-11-23T17:14:06.000000Z',
    updated_at: '2023-11-23T17:21:37.000000Z',
    children: '[]',
    user_id: 542,
    program_id: 3541
  })
};

fetch('https://api.helpyousponsor.com/v1/program/{program_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://api.helpyousponsor.com/v1/program/{program_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 3541,
    'client_id' => '207',
    'hysform_id' => 638,
    'donor_hysform_id' => null,
    'setting_id' => 410,
    'emailset_id' => 1567,
    'entity_submit' => null,
    'donor_submit' => null,
    'link_id' => null,
    'name' => 'adfdfs',
    'prefix' => 'fd',
    'counter' => '0',
    'lft' => 2,
    'rgt' => 5,
    'tree' => 207,
    'box_folder_id' => null,
    'deleted_at' => null,
    'created_at' => '2023-11-23T17:14:06.000000Z',
    'updated_at' => '2023-11-23T17:21:37.000000Z',
    'children' => '[]',
    'user_id' => 542,
    'program_id' => 3541
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-HYS-API-Key: <api-key>"
  ],
]);

$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.helpyousponsor.com/v1/program/{program_id}"

	payload := strings.NewReader("{\n  \"id\": 3541,\n  \"client_id\": \"207\",\n  \"hysform_id\": 638,\n  \"donor_hysform_id\": null,\n  \"setting_id\": 410,\n  \"emailset_id\": 1567,\n  \"entity_submit\": null,\n  \"donor_submit\": null,\n  \"link_id\": null,\n  \"name\": \"adfdfs\",\n  \"prefix\": \"fd\",\n  \"counter\": \"0\",\n  \"lft\": 2,\n  \"rgt\": 5,\n  \"tree\": 207,\n  \"box_folder_id\": null,\n  \"deleted_at\": null,\n  \"created_at\": \"2023-11-23T17:14:06.000000Z\",\n  \"updated_at\": \"2023-11-23T17:21:37.000000Z\",\n  \"children\": \"[]\",\n  \"user_id\": 542,\n  \"program_id\": 3541\n}")

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

	req.Header.Add("X-HYS-API-Key", "<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.put("https://api.helpyousponsor.com/v1/program/{program_id}")
  .header("X-HYS-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": 3541,\n  \"client_id\": \"207\",\n  \"hysform_id\": 638,\n  \"donor_hysform_id\": null,\n  \"setting_id\": 410,\n  \"emailset_id\": 1567,\n  \"entity_submit\": null,\n  \"donor_submit\": null,\n  \"link_id\": null,\n  \"name\": \"adfdfs\",\n  \"prefix\": \"fd\",\n  \"counter\": \"0\",\n  \"lft\": 2,\n  \"rgt\": 5,\n  \"tree\": 207,\n  \"box_folder_id\": null,\n  \"deleted_at\": null,\n  \"created_at\": \"2023-11-23T17:14:06.000000Z\",\n  \"updated_at\": \"2023-11-23T17:21:37.000000Z\",\n  \"children\": \"[]\",\n  \"user_id\": 542,\n  \"program_id\": 3541\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.helpyousponsor.com/v1/program/{program_id}")

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

request = Net::HTTP::Put.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": 3541,\n  \"client_id\": \"207\",\n  \"hysform_id\": 638,\n  \"donor_hysform_id\": null,\n  \"setting_id\": 410,\n  \"emailset_id\": 1567,\n  \"entity_submit\": null,\n  \"donor_submit\": null,\n  \"link_id\": null,\n  \"name\": \"adfdfs\",\n  \"prefix\": \"fd\",\n  \"counter\": \"0\",\n  \"lft\": 2,\n  \"rgt\": 5,\n  \"tree\": 207,\n  \"box_folder_id\": null,\n  \"deleted_at\": null,\n  \"created_at\": \"2023-11-23T17:14:06.000000Z\",\n  \"updated_at\": \"2023-11-23T17:21:37.000000Z\",\n  \"children\": \"[]\",\n  \"user_id\": 542,\n  \"program_id\": 3541\n}"

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

{
  "message": "Program info successfully updated."
}

{
  "message": "Validation error message"
}

User

Client

Email Settings

Commitments

Dashboard

Designation

Donations

Donor

Donors

Sponsorships

Email manager

Auto Emails

Entities

Programs

Program Forms

Progress Reports

Admins & Permissions

Notes

Program Options

Manage Program

Settings

Templates

Files

Frontend

Frontend Donor

Donor Signup

Wrapped

Authorizations

Path Parameters

Body

Response