Skip to main content
POST
/
admin
/
designation
Add a new designation
curl --request POST \
  --url https://api.helpyousponsor.com/v1/admin/designation \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "name": "Designation Name",
  "hysform": "001",
  "emailset_id": 1,
  "code": "D001",
  "client_id": "1"
}
'
import requests

url = "https://api.helpyousponsor.com/v1/admin/designation"

payload = {
"name": "Designation Name",
"hysform": "001",
"emailset_id": 1,
"code": "D001",
"client_id": "1"
}
headers = {
"X-HYS-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-HYS-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Designation Name',
hysform: '001',
emailset_id: 1,
code: 'D001',
client_id: '1'
})
};

fetch('https://api.helpyousponsor.com/v1/admin/designation', 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/admin/designation",
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' => 'Designation Name',
'hysform' => '001',
'emailset_id' => 1,
'code' => 'D001',
'client_id' => '1'
]),
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/admin/designation"

payload := strings.NewReader("{\n \"name\": \"Designation Name\",\n \"hysform\": \"001\",\n \"emailset_id\": 1,\n \"code\": \"D001\",\n \"client_id\": \"1\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://api.helpyousponsor.com/v1/admin/designation")
.header("X-HYS-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Designation Name\",\n \"hysform\": \"001\",\n \"emailset_id\": 1,\n \"code\": \"D001\",\n \"client_id\": \"1\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.helpyousponsor.com/v1/admin/designation")

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

request = Net::HTTP::Post.new(url)
request["X-HYS-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Designation Name\",\n \"hysform\": \"001\",\n \"emailset_id\": 1,\n \"code\": \"D001\",\n \"client_id\": \"1\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Successfull"
}
{
"message": "Bad request"
}
{
"message": "Not found"
}

Authorizations

X-HYS-API-Key
string
header
required

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

Body

application/json

Designation data that needs to be added

name
string
Example:

"Designation Name"

hysform
string
Example:

"001"

emailset_id
integer
Example:

1

code
string
Example:

"D001"

client_id
string
Example:

"1"

Response

Successful operation

message
string
Example:

"Successfull"