> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Send message > **Protocols:** Linked Device API · Meta Cloud API · Polymorfa Hybrid Link **Required scope:** `messages:write` Send a message to a conversation. Put exactly one message kind inside content. Testing sessions send only to active testing numbers in the same project; supply the recipient phoneNumber. ## OpenAPI ````yaml api-reference/features/communicate.json POST /messaging/{session}/messages/send openapi: 3.0.3 info: title: Communicate API methods version: 1.0.0 description: >- Task-focused communicate methods across supported Polymorfa connection types. servers: [] security: [] paths: /messaging/{session}/messages/send: post: tags: - Messages summary: Send message description: >- **Protocols:** Linked Device API · Meta Cloud API · Polymorfa Hybrid Link **Required scope:** `messages:write` Send a message to a conversation. Put exactly one message kind inside content. Testing sessions send only to active testing numbers in the same project; supply the recipient phoneNumber. operationId: nativeSendMessage parameters: - schema: type: string required: true name: session in: path description: Identifier of the connected Polymorfa session. requestBody: content: application/json: schema: $ref: '#/components/schemas/native__SendMessageRequest' example: conversation: phoneNumber: '+15550001111' content: text: Hello responses: '200': description: Message sent successfully content: application/json: schema: $ref: '#/components/schemas/native__SendMessageResponse' '202': description: >- Accepted for asynchronous processing in response to `Prefer: respond-async`; the result is not included content: application/json: schema: $ref: '#/components/schemas/native__AsyncAcceptedResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: invalid_request_error code: invalid_parameter message: Correct the invalid request field. param: null data: null docs: https://docs.polymorfa.com/api/errors#invalid-parameter '401': description: Invalid credential content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: authentication_error code: invalid_credential message: Supply a valid credential. param: null data: null docs: https://docs.polymorfa.com/api/errors#invalid-credential '403': description: Missing scope or resource access content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: permission_error code: permission_denied message: The credential does not have access to this resource. param: null data: null docs: https://docs.polymorfa.com/api/errors#permission-denied '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: invalid_request_error code: resource_not_found message: The resource is unavailable to this caller. param: null data: null docs: https://docs.polymorfa.com/api/errors#resource-not-found '422': description: The supplied media URL could not be fetched content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: invalid_request_error code: invalid_parameter message: Correct the invalid request field. param: null data: null docs: https://docs.polymorfa.com/api/errors#invalid-parameter '500': description: Unexpected service failure content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: api_error code: internal_error message: >- An unexpected service failure occurred. Keep the request ID for support. param: null data: null docs: https://docs.polymorfa.com/api/errors#internal-error '502': description: Messaging provider failure content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: upstream_error code: upstream_failure message: The messaging provider could not complete the request. param: null data: null docs: https://docs.polymorfa.com/api/errors#upstream-failure '503': description: Session or service unavailable content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: api_error code: service_unavailable message: >- A required service is unavailable. Check completion before repeating a write. param: null data: null docs: https://docs.polymorfa.com/api/errors#service-unavailable '504': description: Result unknown after timeout content: application/json: schema: $ref: '#/components/schemas/native__PublicError' example: error: type: api_error code: result_unknown message: >- The result was not obtained before the deadline. Check completion before repeating a write. param: null data: null docs: https://docs.polymorfa.com/api/errors#result-unknown security: - native__BearerAuth: [] servers: - url: https://api.polymorfa.com components: schemas: native__SendMessageRequest: type: object properties: conversation: allOf: - $ref: '#/components/schemas/native__ConversationIdentifier' description: |- Public conversation identifier or E.164 phone number. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Required fields: `id` | | Alternative 2 | Required fields: `phoneNumber` | isForwarded: type: boolean description: Mark this message as forwarded. mentions: type: array items: type: string pattern: ^pmfa_lid_[1-9]\d*$ description: |- User IDs to mention in this message. **Value constraints** | Constraint | Accepted input | | --- | --- | | Item pattern | `^pmfa_lid_[1-9]\d*$` | quotedMessage: allOf: - $ref: '#/components/schemas/native__QuotedMessage' description: Specifies quoted message for this native send message request. content: allOf: - $ref: '#/components/schemas/native__MessageContent' description: >- Specifies content for this native send message request. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `text` | | Alternative 2 | Type: `object`; Required fields: `image` | | Alternative 3 | Type: `object`; Required fields: `video` | | Alternative 4 | Type: `object`; Required fields: `file` | | Alternative 5 | Type: `object`; Required fields: `voice` | | Alternative 6 | Type: `object`; Required fields: `location` | | Alternative 7 | Type: `object`; Required fields: `poll` | | Alternative 8 | Type: `object`; Required fields: `contact` | | Alternative 9 | Type: `object`; Required fields: `requestPhoneNumber` | | Alternative 10 | Type: `object`; Required fields: `product` | | Alternative 11 | Type: `object`; Required fields: `productList` | | Alternative 12 | Type: `object`; Required fields: `order` | | Alternative 13 | Type: `object`; Required fields: `list` | | Alternative 14 | Type: `object`; Required fields: `buttons` | | Alternative 15 | Type: `object`; Required fields: `addressMessage` | | Alternative 16 | Type: `object`; Required fields: `flow` | | Alternative 17 | Type: `object`; Required fields: `template` | required: - conversation - content additionalProperties: false description: >- Specify conversation and content containing exactly one message kind. Shared options remain outside content. native__SendMessageResponse: type: object properties: success: type: boolean enum: - true description: |- Whether the request succeeded. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | data: allOf: - $ref: '#/components/schemas/native__SentMessage' description: Structured data carried by this object. required: - success - data native__AsyncAcceptedResponse: type: object properties: success: type: boolean enum: - true description: |- Whether the request succeeded. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | data: type: object properties: requestId: type: string format: uuid description: |- Identifier used to correlate this request across systems. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | required: - requestId description: Structured data carried by this object. required: - success - data native__PublicError: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string enum: - invalid_parameter - invalid_credential - entitlement_required - method_not_allowed - permission_denied - missing_scope - resource_not_found - media_fetch_failed - resource_gone - state_conflict - rate_limit_exceeded - internal_error - operation_not_supported - upstream_failure - service_unavailable - credential_verification_unavailable - session_not_ready - command_dispatch_failed - result_unknown description: >- Stable machine-readable code for this result. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_parameter` | Invalid parameter. | | `invalid_credential` | Invalid credential. | | `entitlement_required` | Entitlement required. | | `method_not_allowed` | Method not allowed. | | `permission_denied` | Permission denied. | | `missing_scope` | Missing scope. | | `resource_not_found` | Resource not found. | | `media_fetch_failed` | Media fetch failed. | | `resource_gone` | Resource gone. | | `state_conflict` | State conflict. | | `rate_limit_exceeded` | Rate limit exceeded. | | `internal_error` | Internal error. | | `operation_not_supported` | Operation not supported. | | `upstream_failure` | Upstream failure. | | `service_unavailable` | Service unavailable. | | `credential_verification_unavailable` | Credential verification unavailable. | | `session_not_ready` | Session not ready. | | `command_dispatch_failed` | Command dispatch failed. | | `result_unknown` | Result unknown. | message: type: string description: Human-readable message associated with this result. param: type: string nullable: true description: |- Specifies param for this error. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | required: - type - code - message - param description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Specifies docs for this native public error. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | required: - error - data - docs native__ConversationIdentifier: type: object properties: id: type: string description: >- Stable conversation ID. Linked Device users use pmfa_lid_, groups use pmfa_gid_, bots use pmfa_botid_, and Cloud users use their business-scoped ID. example: pmfa_lid_123456789 phoneNumber: type: string pattern: ^\+[1-9]\d{1,14}$ description: >- E.164 phone number. Supply it alone or alongside id; id selects the conversation when both are present. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\+[1-9]\d{1,14}$` | example: '+15550001111' additionalProperties: false description: >- ConversationIdentifier identified by an ID, an E.164 phone number, or both. At least one is required. When both are supplied, the ID selects the conversation and phoneNumber is an alias. User IDs use pmfa_lid_, group IDs use pmfa_gid_, and bot IDs use pmfa_botid_. Cloud API user IDs are business-scoped. anyOf: - required: - id - required: - phoneNumber native__QuotedMessage: type: object properties: messageId: type: string description: Identifier of the WhatsApp message. participant: type: string description: Specifies participant for this native quoted message. type: type: string description: Type discriminator for this object. text: type: string description: Text content carried by this object. required: - messageId - participant description: Message being replied to. native__MessageContent: description: >- Exactly one message kind: text, image, location, or another supported content field. oneOf: - type: object properties: text: type: string minLength: 1 description: |- Text to send. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | required: - text additionalProperties: false - type: object properties: image: type: object properties: url: type: string format: uri description: |- URL of the media to send. Specify this or base64. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | base64: type: string minLength: 1 description: |- Base64-encoded media bytes. Specify this or url. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | mimeType: type: string description: >- MIME type of the media. **Value constraints** | Constraint | Accepted input | | --- | --- | | Media type | IANA `type/subtype` value matching the payload, such as `image/jpeg`, `image/png`, or `image/webp` | caption: type: string description: Caption sent with the media. additionalProperties: false description: Image attached to or representing this resource. required: - image additionalProperties: false - type: object properties: video: type: object properties: url: type: string format: uri description: |- URL of the media to send. Specify this or base64. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | base64: type: string minLength: 1 description: |- Base64-encoded media bytes. Specify this or url. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | mimeType: type: string description: >- MIME type of the media. **Value constraints** | Constraint | Accepted input | | --- | --- | | Media type | IANA `type/subtype` value matching the payload, such as `video/mp4` or `video/3gpp` | caption: type: string description: Caption sent with the media. additionalProperties: false description: Structured video values for this one of. required: - video additionalProperties: false - type: object properties: file: type: object properties: url: type: string format: uri description: |- URL of the media to send. Specify this or base64. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | base64: type: string minLength: 1 description: |- Base64-encoded media bytes. Specify this or url. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | mimeType: type: string description: >- MIME type of the media. **Value constraints** | Constraint | Accepted input | | --- | --- | | Media type | IANA `type/subtype` value matching the payload, such as `application/pdf`, `text/plain`, or `application/vnd.openxmlformats-officedocument.wordprocessingml.document` | caption: type: string description: Caption sent with the media. filename: type: string description: Filename presented for the media attachment. additionalProperties: false description: Structured file values for this one of. required: - file additionalProperties: false - type: object properties: voice: type: object properties: url: type: string format: uri description: |- URL of the media to send. Specify this or base64. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | base64: type: string minLength: 1 description: |- Base64-encoded media bytes. Specify this or url. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | mimeType: type: string description: >- MIME type of the media. **Value constraints** | Constraint | Accepted input | | --- | --- | | Media type | IANA `type/subtype` value matching the payload, such as `audio/ogg`, `audio/mpeg`, or `audio/aac` | caption: type: string description: Caption sent with the media. ptt: type: boolean description: >- Whether the audio is presented as a push-to-talk voice message. additionalProperties: false description: Voice-message content and metadata. required: - voice additionalProperties: false - type: object properties: location: type: object properties: lat: type: number minimum: -90 maximum: 90 description: |- Latitude in decimal degrees. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `-90` through `90` (inclusive) | long: type: number minimum: -180 maximum: 180 description: |- Longitude in decimal degrees. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `-180` through `180` (inclusive) | address: type: string description: Display address for the location. required: - lat - long additionalProperties: false description: Structured location values for this one of. required: - location additionalProperties: false - type: object properties: poll: type: object properties: title: type: string minLength: 1 description: |- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | options: type: array items: type: string minLength: 1 minItems: 2 description: |- Selectable options carried by this object. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | At least `2` items | | Item string length | At least `1` characters | multiSelect: type: boolean description: Whether multi select. required: - title - options additionalProperties: false description: Structured poll values for this one of. required: - poll additionalProperties: false - type: object properties: contact: type: object properties: vcard: type: string minLength: 1 description: |- Specifies vcard for this contact. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | required: - vcard additionalProperties: false description: Structured contact values for this one of. required: - contact additionalProperties: false - type: object properties: requestPhoneNumber: type: object properties: {} additionalProperties: false description: Structured request phone number values for this one of. required: - requestPhoneNumber additionalProperties: false - type: object properties: product: type: object properties: businessOwnerJid: type: string pattern: ^\d+@s\.whatsapp\.net$ description: |- WhatsApp JID for the business owner. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\d+@s\.whatsapp\.net$` | id: type: string minLength: 1 description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | title: type: string minLength: 1 description: |- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | description: type: string minLength: 0 description: |- Human-readable description of this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | currencyCode: type: string pattern: ^[A-Z]{3}$ description: |- ISO 4217 currency code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Z]{3}$` | priceAmount1000: type: integer minimum: 0 maximum: 9007199254740991 description: >- Price expressed in thousandths of the declared currency unit. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `9007199254740991` (inclusive) | salePriceAmount1000: type: integer minimum: 0 maximum: 9007199254740991 description: >- Discounted price expressed in thousandths of the declared currency unit. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `9007199254740991` (inclusive) | retailerId: type: string minLength: 0 description: |- Merchant-defined identifier for the catalog item. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | url: type: string maxLength: 2048 format: uri description: |- URL associated with this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `2048` characters | | Format | `uri` | imageCount: type: integer minimum: 0 maximum: 100 description: |- Number of images. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `100` (inclusive) | image: type: object properties: url: type: string maxLength: 4096 format: uri description: |- URL associated with this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `4096` characters | | Format | `uri` | base64: type: string maxLength: 87384 description: |- Base64-encoded content with no data-URL prefix. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `87384` characters | mimeType: type: string minLength: 0 description: >- IANA media type that matches the media payload. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | | Media type | IANA `type/subtype` value matching the payload, such as `image/jpeg`, `image/png`, or `image/webp` | description: Image attached to or representing this resource. body: type: string minLength: 0 description: |- Primary text content shown to the recipient. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | footer: type: string minLength: 0 description: |- Supplementary footer text shown below the primary content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | required: - businessOwnerJid - id - title - currencyCode - priceAmount1000 description: Structured product values for this one of. required: - product additionalProperties: false - type: object properties: productList: type: object properties: businessOwnerJid: type: string pattern: ^\d+@s\.whatsapp\.net$ description: |- WhatsApp JID for the business owner. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\d+@s\.whatsapp\.net$` | title: type: string minLength: 1 description: |- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | description: type: string minLength: 0 description: |- Human-readable description of this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | buttonText: type: string minLength: 1 description: |- Text displayed on the action button. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | footer: type: string minLength: 0 description: |- Supplementary footer text shown below the primary content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | sections: type: array items: type: object properties: title: type: string minLength: 0 description: >- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | productIds: type: array items: type: string minLength: 1 minItems: 1 maxItems: 30 description: |- Identifiers of the products included in this section. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `30` items | | Item string length | At least `1` characters | required: - productIds minItems: 1 maxItems: 10 description: >- Ordered sections displayed in the interactive message. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `10` items | | Total products | At most `30` product IDs across all sections | | Product IDs | Every product ID must be unique across all sections | required: - businessOwnerJid - title - buttonText - sections description: Structured product list values for this one of. required: - productList additionalProperties: false - type: object properties: order: type: object properties: id: type: string minLength: 1 description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | thumbnailBase64: type: string maxLength: 87384 description: |- Base64-encoded thumbnail content with no data-URL prefix. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `87384` characters | itemCount: type: integer minimum: 1 maximum: 100 description: |- Number of items. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `100` (inclusive) | status: type: string enum: - inquiry - accepted - declined description: |- Order status sent with this business order. **Allowed values** | Value | Meaning | | --- | --- | | `inquiry` | Inquiry. | | `accepted` | Accepted. | | `declined` | Declined. | message: type: string minLength: 0 description: |- Outbound message content attached to this business order. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | title: type: string minLength: 0 description: |- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | sellerJid: type: string pattern: ^\d+@s\.whatsapp\.net$ description: |- WhatsApp JID for the seller. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\d+@s\.whatsapp\.net$` | token: type: string minLength: 0 description: |- Opaque token required by the target operation. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | totalAmount1000: type: integer minimum: 0 maximum: 9007199254740991 description: >- Order total expressed in thousandths of the declared currency unit. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `9007199254740991` (inclusive) | totalCurrencyCode: type: string pattern: ^[A-Z]{3}$ description: |- ISO 4217 currency code used for the order total. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Z]{3}$` | catalogType: type: string minLength: 0 description: |- Category assigned to catalog. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | required: - id - itemCount - status - sellerJid - totalAmount1000 - totalCurrencyCode description: Structured order values for this one of. required: - order additionalProperties: false - type: object properties: list: type: object properties: title: type: string minLength: 1 description: |- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | description: type: string minLength: 0 description: |- Human-readable description of this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | buttonText: type: string minLength: 1 description: |- Text displayed on the action button. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | footer: type: string minLength: 0 description: |- Supplementary footer text shown below the primary content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | sections: type: array items: type: object properties: title: type: string minLength: 0 description: >- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | rows: type: array items: type: object properties: id: type: string minLength: 1 description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | title: type: string minLength: 1 description: >- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | description: type: string minLength: 0 description: |- Human-readable description of this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | required: - id - title minItems: 1 maxItems: 30 description: |- Rows associated with this section. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `30` items | required: - rows minItems: 1 maxItems: 10 description: >- Ordered sections displayed in the interactive message. **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `10` items | | Total rows | At most `30` rows across all sections | | Row IDs | Every row ID must be unique across all sections | required: - title - buttonText - sections description: Structured list values for this one of. required: - list additionalProperties: false - type: object properties: buttons: type: object properties: title: type: string minLength: 0 description: |- Human-readable title shown to the recipient or operator. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | body: type: string minLength: 1 description: |- Primary text content shown to the recipient. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | footer: type: string minLength: 0 description: |- Supplementary footer text shown below the primary content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | buttons: type: array items: oneOf: - type: object properties: type: type: string enum: - url description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `url` | Url. | text: type: string minLength: 1 description: |- Text content carried by this object. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | url: type: string maxLength: 2048 format: uri description: |- URL associated with this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At most `2048` characters | | Format | `uri` | required: - type - text - url - type: object properties: type: type: string enum: - call description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `call` | Call. | text: type: string minLength: 1 description: |- Text content carried by this object. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | phoneNumber: type: string pattern: ^\+?\d{6,20}$ description: |- Phone number in international format. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\+?\d{6,20}$` | required: - type - text - phoneNumber - type: object properties: type: type: string enum: - reply description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `reply` | Reply. | text: type: string minLength: 1 description: |- Text content carried by this object. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | id: type: string minLength: 1 description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | required: - type - text - id - type: object properties: type: type: string enum: - copy description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `copy` | Copy. | text: type: string minLength: 1 description: |- Text content carried by this object. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | copyCode: type: string minLength: 1 description: >- Text copied when the recipient activates the copy-code button. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | required: - type - text - copyCode - type: object properties: type: type: string enum: - catalog description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `catalog` | Catalog. | text: type: string minLength: 1 description: |- Text content carried by this object. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | businessPhoneNumber: type: string pattern: ^\+?\d{6,20}$ description: >- WhatsApp business phone number whose catalog is opened by this button. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^\+?\d{6,20}$` | catalogProductId: type: string minLength: 0 description: |- Identifier for the catalog product. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | required: - type - text - businessPhoneNumber minItems: 1 maxItems: 3 description: >- Interactive buttons displayed with the message. **Accepted alternatives** | Item alternative | Accepted input | | --- | --- | | Item alternative 1 | Type: `object`; Field `type`: `url`; Required fields: `type`, `text`, `url` | | Item alternative 2 | Type: `object`; Field `type`: `call`; Required fields: `type`, `text`, `phoneNumber` | | Item alternative 3 | Type: `object`; Field `type`: `reply`; Required fields: `type`, `text`, `id` | | Item alternative 4 | Type: `object`; Field `type`: `copy`; Required fields: `type`, `text`, `copyCode` | | Item alternative 5 | Type: `object`; Field `type`: `catalog`; Required fields: `type`, `text`, `businessPhoneNumber` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Array size | `1` through `3` items | required: - body - buttons description: Interactive buttons displayed with the message. required: - buttons additionalProperties: false - type: object properties: addressMessage: type: object properties: body: type: string minLength: 1 description: |- Primary text content shown to the recipient. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | buttonText: type: string minLength: 1 description: |- Text displayed on the action button. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | footer: type: string minLength: 0 description: |- Supplementary footer text shown below the primary content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | country: type: string pattern: ^[A-Z]{2}$ description: |- ISO 3166-1 alpha-2 country code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[A-Z]{2}$` | required: - body description: Structured address message values for this one of. required: - addressMessage additionalProperties: false - type: object properties: flow: type: object properties: body: type: string minLength: 1 description: |- Primary text content shown to the recipient. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | buttonText: type: string minLength: 1 description: |- Text displayed on the action button. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | footer: type: string minLength: 0 description: |- Supplementary footer text shown below the primary content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | id: type: string minLength: 1 description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | token: type: string minLength: 1 description: |- Opaque token required by the target operation. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | action: type: string enum: - navigate - data_exchange description: |- Action performed when the recipient activates this control. **Allowed values** | Value | Meaning | | --- | --- | | `navigate` | Navigate. | | `data_exchange` | Data exchange. | screen: type: string minLength: 0 description: |- Flow screen opened when the recipient activates the message. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | dataJson: type: string minLength: 0 description: >- JSON object encoded as a string and supplied to the Flow interaction. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `0` characters | | Serialized value | A non-null JSON object; arrays, scalar values, and invalid JSON are not accepted | | UTF-8 size | At most `16` KiB (`16,384` bytes) | required: - body - buttonText - id - token - action oneOf: - properties: action: enum: - navigate description: |- Action represented by this one of. **Allowed values** | Value | Meaning | | --- | --- | | `navigate` | Navigate. | required: - screen - properties: action: enum: - data_exchange description: |- Action represented by this one of. **Allowed values** | Value | Meaning | | --- | --- | | `data_exchange` | Data exchange. | not: anyOf: - required: - screen - required: - dataJson description: >- Structured flow values for this one of. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `action`: `navigate`; Required fields: `screen` | | Alternative 2 | Type: `object`; Field `action`: `data_exchange`; Forbidden fields: `screen`, `dataJson` | required: - flow additionalProperties: false - type: object properties: template: type: object properties: name: type: string minLength: 1 description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `1` characters | language: type: string minLength: 2 description: |- Language or locale code used for this content. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | At least `2` characters | components: type: array items: {} description: Structured components that make up this message or template. required: - name - language additionalProperties: false description: Structured template values for this one of. required: - template additionalProperties: false native__SentMessage: type: object properties: id: type: string description: Identifier for this resource. conversation: allOf: - $ref: '#/components/schemas/native__ConversationIdentifier' description: |- Public conversation identifier or E.164 phone number. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Required fields: `id` | | Alternative 2 | Required fields: `phoneNumber` | timestamp: type: string format: date-time description: |- ISO 8601 timestamp associated with this event. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `date-time` | status: type: string description: >- Upstream acceptance status. Delivery and read receipts arrive separately. type: type: string description: Type discriminator for this object. content: allOf: - $ref: '#/components/schemas/native__MessageContent' description: >- Specifies content for this native sent message. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Required fields: `text` | | Alternative 2 | Type: `object`; Required fields: `image` | | Alternative 3 | Type: `object`; Required fields: `video` | | Alternative 4 | Type: `object`; Required fields: `file` | | Alternative 5 | Type: `object`; Required fields: `voice` | | Alternative 6 | Type: `object`; Required fields: `location` | | Alternative 7 | Type: `object`; Required fields: `poll` | | Alternative 8 | Type: `object`; Required fields: `contact` | | Alternative 9 | Type: `object`; Required fields: `requestPhoneNumber` | | Alternative 10 | Type: `object`; Required fields: `product` | | Alternative 11 | Type: `object`; Required fields: `productList` | | Alternative 12 | Type: `object`; Required fields: `order` | | Alternative 13 | Type: `object`; Required fields: `list` | | Alternative 14 | Type: `object`; Required fields: `buttons` | | Alternative 15 | Type: `object`; Required fields: `addressMessage` | | Alternative 16 | Type: `object`; Required fields: `flow` | | Alternative 17 | Type: `object`; Required fields: `template` | mediaId: type: string description: Identifier for the media. required: - id - conversation - timestamp - status - type - content securitySchemes: native__BearerAuth: type: http scheme: bearer description: >- Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules. ````