> ## Documentation Index > Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt > Use this file to discover all available pages before exploring further. # Create a partnership deal ## OpenAPI ````yaml /partner-openapi.json post /partner/{partnershipId}/deals openapi: 3.1.0 info: title: Journeybee Partner API description: Partner-facing REST API for the Journeybee PRM platform. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Partner description: Partner-facing API endpoints — used only by the partner spec paths: /partner/{partnershipId}/deals: post: tags: - Partner summary: Create a partnership deal operationId: createPartnerDeal parameters: - schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: path name: partnershipId required: true requestBody: required: true content: application/json: schema: type: object properties: deal_label: type: string stage_uuid: type: string tags: type: array items: type: string customFields: type: array items: type: object properties: customFieldId: type: string type: type: string enum: - text - textarea - number - date - boolean - select - multi_select value: anyOf: - type: object properties: text: description: Value for text/url/email/phone fields anyOf: - type: string - type: 'null' number: description: Value for number fields anyOf: - anyOf: - type: number - type: string - type: 'null' date: description: Value for date fields (ISO 8601 date string) anyOf: - type: string - type: 'null' boolean: description: Value for checkbox fields anyOf: - anyOf: - type: boolean - type: string - type: 'null' select: description: Option ID for single-select fields anyOf: - type: number - type: 'null' multi_select: description: Option IDs for multi-select fields anyOf: - type: array items: type: number - type: 'null' additionalProperties: false description: >- Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs). - type: 'null' required: - customFieldId - type additionalProperties: false expiration_days: type: number lead_id: type: string deal_value: type: number products: type: array items: type: object properties: product_id: type: string quantity: type: number required: - product_id additionalProperties: false notes: type: array items: type: object properties: document: anyOf: - type: object properties: type: type: string content: type: array items: type: object additionalProperties: true required: - type additionalProperties: false - type: 'null' attachments: anyOf: - type: array items: type: object properties: uuid: type: string internalId: type: string name: type: string size: type: number isImage: type: boolean mimeType: type: string file: anyOf: - type: object additionalProperties: {} - type: 'null' externalUrl: anyOf: - type: string - type: 'null' cdnUrlModifiers: type: string cdnUrl: type: string fullPath: anyOf: - type: string - type: 'null' uploadProgress: type: number fileInfo: type: object properties: uuid: type: string name: type: string size: type: number isStored: type: boolean isImage: type: boolean mimeType: type: string cdnUrl: type: string s3Url: anyOf: - type: string - type: 'null' originalFilename: type: string imageInfo: anyOf: - type: object properties: dpi: anyOf: - type: array items: type: number - type: 'null' width: type: number format: type: string height: type: number sequence: type: boolean colorMode: type: string orientation: anyOf: - type: number - type: 'null' geoLocation: anyOf: - type: object properties: latitude: type: number longitude: type: number additionalProperties: false - type: 'null' datetimeOriginal: anyOf: - type: string - type: 'null' additionalProperties: false - type: 'null' videoInfo: anyOf: - type: object properties: duration: anyOf: - type: number - type: 'null' format: anyOf: - type: string - type: 'null' bitrate: anyOf: - type: number - type: 'null' audio: anyOf: - type: object properties: bitrate: anyOf: - type: number - type: 'null' codec: anyOf: - type: string - type: 'null' sampleRate: anyOf: - type: number - type: 'null' channels: anyOf: - anyOf: - type: string - type: number - type: 'null' additionalProperties: false - type: 'null' video: anyOf: - type: object properties: height: anyOf: - type: number - type: 'null' width: anyOf: - type: number - type: 'null' frameRate: anyOf: - type: number - type: 'null' bitrate: anyOf: - type: number - type: 'null' codec: anyOf: - type: string - type: 'null' additionalProperties: false - type: 'null' additionalProperties: false - type: 'null' contentInfo: anyOf: - type: object properties: mime: type: object properties: mime: type: string type: type: string subtype: type: string additionalProperties: false image: type: object properties: dpi: anyOf: - type: array items: type: number - type: 'null' width: type: number format: type: string height: type: number sequence: type: boolean colorMode: type: string orientation: anyOf: - type: number - type: 'null' geoLocation: anyOf: - type: object properties: latitude: type: number longitude: type: number additionalProperties: false - type: 'null' datetimeOriginal: anyOf: - type: string - type: 'null' additionalProperties: false additionalProperties: false - type: 'null' metadata: anyOf: - type: object additionalProperties: {} - type: 'null' s3Bucket: anyOf: - type: string - type: 'null' defaultEffects: anyOf: - type: string - type: 'null' additionalProperties: false metadata: anyOf: - type: object additionalProperties: {} - type: 'null' isSuccess: type: boolean isUploading: type: boolean isFailed: type: boolean isRemoved: type: boolean errors: type: array items: {} status: type: string enum: - success source: anyOf: - type: string - type: 'null' additionalProperties: false - type: array items: type: number mentions: type: array items: type: object properties: id: type: number label: type: string required: - id - label additionalProperties: false required: - document - mentions additionalProperties: false currency_code: type: string maxLength: 10 required: - lead_id additionalProperties: false responses: '201': description: Default Response content: application/json: schema: type: object properties: id: type: string uuid: type: string required: - id - uuid additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````