Create Deal Registration

post

https://{region}.api.jamfcloud.com/partners/v1/deal-registrations

Submits a new deal registration for the partner organization resolved from the access token, against a prospective end customer. The registration is created in PENDING status and awaits Jamf review.

On success the Location header points at the new registration's GET /deal-registrations/{partnerRegistrationId} endpoint, and the response body carries that same identifier as id alongside its href.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The deal registration to create.

A new deal registration to submit against a prospective end customer. The partner organization is resolved from the access token, so it does not appear in the body.

firstName

string

Given name of the contact at the prospective end customer.

lastName

string

Family name of the contact at the prospective end customer.

jobTitle

string | null

Job title of the contact at the prospective end customer.

phone

string | null

Telephone number of the contact.

string

Email address of the contact at the prospective end customer.

organizationName

string

Name of the prospective end customer organization.

website

string | null

Website of the prospective end customer organization.

businessType

string

enum

Market segment of the prospective end customer.

Allowed:

newCustomer

boolean

Whether the prospective end customer is new to Jamf rather than an existing customer.

newProductLine

boolean | null

Whether the opportunity introduces a Jamf product line the customer does not already own.

employeeStudentCnt

integer

Number of employees or students at the prospective end customer organization.

deviceCntRange

string | null

Estimated device count for the opportunity, as a range.

address

object

Address of the prospective end customer.

productInterests

array of strings | null

Jamf products the prospective end customer is interested in.

productInterests

expectedCloseDate

string | null

Date the partner expects the opportunity to close, as submitted.

budgetApproved

boolean | null

Whether the prospective end customer has approved budget for the purchase.

additionalSupports

array of strings | null

Additional support the partner is requesting from Jamf for the opportunity.

additionalSupports

additionalNotes

string | null

Free-form notes about the opportunity.

primaryDistributorAccountId

string | null

Identifier of the primary distributor for the opportunity.

secondaryDistributorAccountId

string | null

Identifier of the secondary distributor for the opportunity, if any.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The deal registration was created in PENDING status. The Location header points at the new registration and the body carries its id and href.

400Bad Request. The request body could not be parsed as JSON (MALFORMED_REQUEST_BODY), or the deal registration was rejected by the upstream partner platform (UPSTREAM_ERROR).

401Unauthorized. The access token is missing, invalid, or expired. The API Gateway rejects the request before it reaches the service.

403Forbidden. The token is not an external M2M token, or it does not carry the scope required to reach this endpoint.

500Internal Server Error. The organization in the token could not be resolved, or an upstream dependency failed. The description is deliberately generic; quote traceId when reporting the failure.