cURL
curl --request PATCH \
--url https://sandbox.withclasp.com/employers/{public_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"legal_name": "<string>",
"trade_name": "<string>",
"external_id": "<string>",
"phone_number": "<string>",
"email": "<string>",
"federal_ein": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zip_code": "<string>",
"line2": "<string>"
},
"user_assignments": [
"<string>"
],
"metadata": {}
}
'import requests
url = "https://sandbox.withclasp.com/employers/{public_id}"
payload = {
"legal_name": "<string>",
"trade_name": "<string>",
"external_id": "<string>",
"phone_number": "<string>",
"email": "<string>",
"federal_ein": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zip_code": "<string>",
"line2": "<string>"
},
"user_assignments": ["<string>"],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
legal_name: '<string>',
trade_name: '<string>',
external_id: '<string>',
phone_number: '<string>',
email: '<string>',
federal_ein: '<string>',
address: {line1: '<string>', city: '<string>', zip_code: '<string>', line2: '<string>'},
user_assignments: ['<string>'],
metadata: {}
})
};
fetch('https://sandbox.withclasp.com/employers/{public_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://sandbox.withclasp.com/employers/{public_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([
'legal_name' => '<string>',
'trade_name' => '<string>',
'external_id' => '<string>',
'phone_number' => '<string>',
'email' => '<string>',
'federal_ein' => '<string>',
'address' => [
'line1' => '<string>',
'city' => '<string>',
'zip_code' => '<string>',
'line2' => '<string>'
],
'user_assignments' => [
'<string>'
],
'metadata' => [
]
]),
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://sandbox.withclasp.com/employers/{public_id}"
payload := strings.NewReader("{\n \"legal_name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"federal_ein\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"line2\": \"<string>\"\n },\n \"user_assignments\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.withclasp.com/employers/{public_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"legal_name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"federal_ein\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"line2\": \"<string>\"\n },\n \"user_assignments\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.withclasp.com/employers/{public_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"legal_name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"federal_ein\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"line2\": \"<string>\"\n },\n \"user_assignments\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"legal_name": "<string>",
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"trade_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"federal_ein": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zip_code": "<string>",
"line2": "<string>"
},
"primary_business_unit": "<string>",
"user_assignments": [
"<string>"
],
"metadata": {}
}Employers
Update Employer
Updates an employer’s details.
PATCH
/
employers
/
{public_id}
cURL
curl --request PATCH \
--url https://sandbox.withclasp.com/employers/{public_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"legal_name": "<string>",
"trade_name": "<string>",
"external_id": "<string>",
"phone_number": "<string>",
"email": "<string>",
"federal_ein": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zip_code": "<string>",
"line2": "<string>"
},
"user_assignments": [
"<string>"
],
"metadata": {}
}
'import requests
url = "https://sandbox.withclasp.com/employers/{public_id}"
payload = {
"legal_name": "<string>",
"trade_name": "<string>",
"external_id": "<string>",
"phone_number": "<string>",
"email": "<string>",
"federal_ein": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zip_code": "<string>",
"line2": "<string>"
},
"user_assignments": ["<string>"],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
legal_name: '<string>',
trade_name: '<string>',
external_id: '<string>',
phone_number: '<string>',
email: '<string>',
federal_ein: '<string>',
address: {line1: '<string>', city: '<string>', zip_code: '<string>', line2: '<string>'},
user_assignments: ['<string>'],
metadata: {}
})
};
fetch('https://sandbox.withclasp.com/employers/{public_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://sandbox.withclasp.com/employers/{public_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([
'legal_name' => '<string>',
'trade_name' => '<string>',
'external_id' => '<string>',
'phone_number' => '<string>',
'email' => '<string>',
'federal_ein' => '<string>',
'address' => [
'line1' => '<string>',
'city' => '<string>',
'zip_code' => '<string>',
'line2' => '<string>'
],
'user_assignments' => [
'<string>'
],
'metadata' => [
]
]),
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://sandbox.withclasp.com/employers/{public_id}"
payload := strings.NewReader("{\n \"legal_name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"federal_ein\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"line2\": \"<string>\"\n },\n \"user_assignments\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.withclasp.com/employers/{public_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"legal_name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"federal_ein\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"line2\": \"<string>\"\n },\n \"user_assignments\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.withclasp.com/employers/{public_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"legal_name\": \"<string>\",\n \"trade_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"federal_ein\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"line2\": \"<string>\"\n },\n \"user_assignments\": [\n \"<string>\"\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"legal_name": "<string>",
"external_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"trade_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"federal_ein": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"zip_code": "<string>",
"line2": "<string>"
},
"primary_business_unit": "<string>",
"user_assignments": [
"<string>"
],
"metadata": {}
}Authorizations
API Key authentication with required prefix "Bearer"
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
10Maximum string length:
255Maximum string length:
255Show child attributes
Show child attributes
Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.
Show child attributes
Show child attributes
Response
200 - application/json
Pattern:
^[-a-zA-Z0-9_]+$Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
10Maximum string length:
255Maximum string length:
255Show child attributes
Show child attributes
not_started- Not Startedpending- Pendingprocessing- Processingneeds_attention- Needs Attentionreview- Reviewcompleted- Completedinactive- Inactive
Available options:
not_started, pending, processing, needs_attention, review, completed, inactive Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.
Show child attributes
Show child attributes
⌘I