> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Register deal > Register a deal ```http POST https://api2.rhombussystems.com/api/partner/registerDeal ``` EU organizations send the same request to `https://api2.eu.rhombussystems.com`. ## Authentication and parameters - `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). - `Authorization` (header): instead of an API key, an OAuth access token (`Bearer `) with the `write` scope. - `x-auth-scheme` (header, string, default: `partner-api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`. - `x-auth-org` (header, string): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`. ## Request body Content type: `application/json`. Request object for registering a deal with partner details. - `details` (map | null): Map of deal details with key-value pairs ## Response 200 OK. Content type: `application/json` - `clients` (array | null): List of partner clients associated with the registered deal - `error` (boolean | null) - `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. - `errorMsg` (string | null) - `warningMsg` (string | null) ## Errors Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors ## OpenAPI ````yaml openapi: 3.0.1 info: title: Rhombus API version: "1.0" servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/partner/registerDeal: post: description: Register a deal operationId: registerDeal parameters: - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters." example: partner-api-token in: header name: x-auth-scheme required: false schema: default: partner-api-token enum: - api-token - api - api-oauth-token - federated-token - partner-api-token - partner-api - partner-api-oauth-token type: string - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`." in: header name: x-auth-org required: false schema: format: RUUID maxLength: 22 minLength: 22 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Partner_RegisterDealWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Partner_RegisterDealWSResponse" description: OK "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "429": $ref: "#/components/responses/TooManyRequests" "500": $ref: "#/components/responses/InternalServerError" "503": $ref: "#/components/responses/ServiceUnavailable" security: - ApiKeyAuth: [] - oauth2: - write summary: Register deal tags: - Partner Webservice components: schemas: Partner_RegisterDealWSRequest: description: Request object for registering a deal with partner details. properties: details: additionalProperties: description: Map of deal details with key-value pairs nullable: true type: string description: Map of deal details with key-value pairs nullable: true type: object type: object Partner_RegisterDealWSResponse: description: Response object containing the result of registering a deal. properties: clients: description: List of partner clients associated with the registered deal items: $ref: "#/components/schemas/Partner_PartnerClientWebType" nullable: true type: array error: nullable: true type: boolean errorCode: description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. nullable: true type: string errorMsg: nullable: true type: string warningMsg: nullable: true type: string type: object Partner_PartnerClientWebType: description: Partner client information including organization details and device counts. properties: authorityUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string clientAccessAllowed: description: Whether client access is allowed (duplicate getter) example: true nullable: true type: boolean clientAccountAccessUrl: description: URL for accessing the client account example: https://console.rhombussystems.com/client/access nullable: true type: string clientOrgName: description: Name of the client organization example: Acme Corporation nullable: true type: string clientOrgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string clientSuperAdminAssignable: description: "MSP initiative (D3): false when the MSP has restricted the client org's Super Admin role." nullable: true type: boolean createdAtMillis: description: Timestamp when the client was created (milliseconds since epoch) example: 1640995200000 format: int64 nullable: true type: integer deactivated: description: "MSP initiative: true when the client org is soft-deleted (only returned with includeDeactivated=true)." nullable: true type: boolean deactivatedAtMillis: description: "MSP initiative: when the client org was deactivated, if it is." format: int64 nullable: true type: integer managedByMsp: description: "MSP initiative: true when this client is a managed org owned by the calling MSP (permanent authority)." nullable: true type: boolean totalAudioGateways: description: Total number of audio gateways example: 4 format: int32 nullable: true type: integer totalBadgeReaders: description: Total number of badge readers example: 12 format: int32 nullable: true type: integer totalCameras: description: Total number of cameras example: 25 format: int32 nullable: true type: integer totalClimateSensors: description: Total number of climate sensors example: 10 format: int32 nullable: true type: integer totalDoorSensors: description: Total number of door sensors example: 8 format: int32 nullable: true type: integer totalLocations: description: Total number of locations example: 3 format: int32 nullable: true type: integer totalOccupancySensors: description: Total number of occupancy sensors example: 6 format: int32 nullable: true type: integer totalProximitySensors: description: Total number of proximity sensors example: 5 format: int32 nullable: true type: integer type: object securitySchemes: ApiKeyAuth: description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). in: header name: x-auth-apikey type: apiKey oauth2: description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer `. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.' flows: authorizationCode: authorizationUrl: https://console.rhombus.com/oauth/authorize refreshUrl: https://auth-web.rhombussystems.com/oauth/token scopes: physical: Unlock doors and elevators, lockdown, alarms, speakers and robots read: View cameras, footage and settings write: Change settings and data tokenUrl: https://auth-web.rhombussystems.com/oauth/token type: oauth2 ````