Skip to main content
POST
/
employers
cURL
curl --request POST \
  --url https://sandbox.withclasp.com/employers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "legal_name": "<string>",
  "external_id": "<string>",
  "trade_name": "<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"

payload = {
"legal_name": "<string>",
"external_id": "<string>",
"trade_name": "<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.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
legal_name: '<string>',
external_id: '<string>',
trade_name: '<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', 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",
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([
'legal_name' => '<string>',
'external_id' => '<string>',
'trade_name' => '<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"

payload := strings.NewReader("{\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"trade_name\": \"<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("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://sandbox.withclasp.com/employers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"trade_name\": \"<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")

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 \"legal_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"trade_name\": \"<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

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Body

Maximum string length: 255
external_id
string
required
Maximum string length: 255
trade_name
string | null
Maximum string length: 255
phone_number
string | null
Maximum string length: 10
email
string | null
Maximum string length: 255
federal_ein
string | null
Maximum string length: 255
address
object | null
user_assignments
string[]
metadata
object

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.

Response

201 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
Maximum string length: 255
external_id
string
required
Maximum string length: 255
created_at
string<date-time>
required
read-only
trade_name
string | null
Maximum string length: 255
phone_number
string | null
Maximum string length: 10
email
string | null
Maximum string length: 255
federal_ein
string | null
Maximum string length: 255
address
object | null
status
enum<string>
  • not_started - Not Started
  • pending - Pending
  • processing - Processing
  • needs_attention - Needs Attention
  • review - Review
  • completed - Completed
  • inactive - Inactive
Available options:
not_started,
pending,
processing,
needs_attention,
review,
completed,
inactive
primary_business_unit
string
read-only
user_assignments
string[]
metadata
object

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.