Skip to content

Deel: Create a deal registration

Deel organizations.createDealRegistration: arguments, response, policy and SDK examples.

← Organizations operations · Get started

Operation deel.organizations_createdealregistration_v2026_09_30

Provider route: POST /organizations/deal-registrations. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["organizations"]["createDealRegistration"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.organizations.createDealRegistration(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.organizations.create_deal_registration(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand Create a deal registration — request body — body data
The request payload.

Referenced models: Create a deal registration — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a deal registration — 200 response body

Referenced models: Create a deal registration — 200 response body

Create a deal registration — request body — body data
FieldTypePresenceDescription and constraints
$objectRootThe request payload.
company_domainstringRequired within parentThe end client's company domain. A scheme, a "www." prefix and a path are accepted and stripped before matching.
Maximum length: 255
Minimum length: 4
company_namestringRequired within parentThe end client's legal company name.
Maximum length: 255
Minimum length: 1
countriesarrayOptionalOptional ISO 3166-1 alpha-2 codes for the countries the deal covers.
countries[]stringEach itemMaximum length: 2
Minimum length: 2
expected_deal_sizenumberRequired within parentThe expected annual contract value of the deal.
Format: double
Maximum: 1000000000
Minimum: 1
productsarrayRequired within parentThe Deel products the partner expects to sell.
products[]stringEach itemOne of: EOR, IC, COR, GP, Contractor Management, US Payroll, PEO, Immigration, Deel HR, Deel IT
regionstringRequired within parentThe sales region the deal belongs to.
One of: NAM, EMEA, APAC, LATAM
Create a deal registration — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a deal registration — 200 response body — data

Referenced models: Create a deal registration — 200 response body — data

Create a deal registration — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
approved_atstringOptionalThe date the registration was approved. Present only when the status is APPROVED.
Format: date
company_domainstringOptionalThe normalised root domain stored on the registration. Absent when the status is REJECTED.
company_namestringOptionalThe company name stored on the registration. Absent when the status is REJECTED.
countriesarrayOptionalThe countries stored on the registration, or an empty array when none are stored. Absent when the status is REJECTED.
countries[]stringEach item
expected_deal_sizeJSONOptional
expected_deal_size (anyOf 1)numberAlternativeThe expected deal size stored on the registration. Absent when the status is REJECTED.
Format: double
expected_deal_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_atstringOptionalThe date the 90-day protection window ends. Present only when the status is APPROVED.
Format: date
messagestringOptionalA generic ineligibility message. Present only when the status is REJECTED. It is deliberately identical for every rejection reason.
productsarrayOptionalThe products stored on the registration. Absent when the status is REJECTED.
products[]stringEach item
regionstringOptionalThe region stored on the registration. Absent when the status is REJECTED.
statusstringRequired within parentThe eligibility outcome. APPROVED means the protection window is now active. REJECTED means the deal is not eligible.
Known values: APPROVED, REJECTED

SDK function policy ID: deel.organizations_createdealregistration_v2026_09_30. Catalog operation: organizations_createdealregistration_v2026_09_30. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["organizations:write"]

Pinned headers: {"X-Version": "2026-09-30"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.