> ## Documentation Index > Fetch the complete documentation index at: https://docs.buildwithchirp.com/llms.txt > Use this file to discover all available pages before exploring further. # Register WhatsApp phone number > Register a WhatsApp phone number with Meta's phone_number_id and optionally assign it to apps ## OpenAPI ````yaml /openapi.json post /v1/organization/whatsapp/phone-numbers openapi: 3.1.0 info: version: 1.0.0 title: Chirp API description: Communication APIs for SMS, MMS, and WhatsApp messaging servers: - url: https://api.buildwithchirp.com security: [] paths: /v1/organization/whatsapp/phone-numbers: post: tags: - Admin - WhatsApp Phone Numbers requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterWhatsAppPhoneNumberRequest' responses: '201': description: WhatsApp phone number registered successfully content: application/json: schema: $ref: '#/components/schemas/WhatsAppPhoneNumber' '400': description: Bad request - invalid input or phone number already exists content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' security: - adminAuth: [] components: schemas: RegisterWhatsAppPhoneNumberRequest: type: object properties: displayPhoneNumber: type: string example: '+15551234567' description: The display phone number in E.164 format metaPhoneNumberId: type: string example: '123456789012345' description: The phone_number_id from Meta's WhatsApp Business API metaBusinessAccountId: type: string example: '987654321098765' description: The WhatsApp Business Account ID from Meta appIds: type: array items: type: string example: - app_2DbBs7GWhGvVNJGrDXr5RG0mBWI description: Optional array of app IDs to assign the phone number to required: - displayPhoneNumber - metaPhoneNumberId - metaBusinessAccountId WhatsAppPhoneNumber: type: object properties: id: type: string pattern: ^wapn_(?:test_)?[a-zA-Z0-9]{27}$ example: wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI description: >- Unique identifier for a WhatsApp Phone Number. Format: wapn_[test_]{ksuid} displayPhoneNumber: type: string metaPhoneNumberId: type: string metaBusinessAccountId: type: string verified: type: boolean qualityRating: type: - string - 'null' throughputTier: type: - string - 'null' description: >- Messaging throughput tier from phone_number_quality_update (e.g. STANDARD, HIGH) qualityEvent: type: - string - 'null' description: Most recent quality event (e.g. FLAGGED, ONBOARDED, UPGRADE) qualityEventAt: type: - string - 'null' format: date-time nameStatus: type: - string - 'null' description: >- Display name verification status (APPROVED, REJECTED, PENDING, DEFERRED) requestedVerifiedName: type: - string - 'null' nameRejectionReason: type: - string - 'null' nameDecisionAt: type: - string - 'null' format: date-time isTestNumber: type: boolean cloudApiRegistered: type: boolean description: >- Whether the phone number has been registered with Meta Cloud API (two-step verification) businessProfile: $ref: '#/components/schemas/WhatsAppPhoneNumberBusinessProfile' apps: type: array items: $ref: '#/components/schemas/WhatsAppPhoneNumberAppAssociation' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - displayPhoneNumber - metaPhoneNumberId - metaBusinessAccountId - verified - qualityRating - throughputTier - qualityEvent - qualityEventAt - nameStatus - requestedVerifiedName - nameRejectionReason - nameDecisionAt - isTestNumber - cloudApiRegistered - businessProfile - apps - createdAt - updatedAt ApiError: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - provider_error - api_error description: The type of error returned example: invalid_request_error code: type: string enum: - message_undeliverable - conversation_window_expired - recipient_not_on_whatsapp - phone_number_not_assigned - unsupported_message_type - media_too_large - invalid_phone_number - template_not_found - template_parameter_mismatch - groups_not_eligible - account_restricted - display_name_not_approved - whatsapp_not_configured - meta_api_error - meta_api_unavailable - telnyx_api_error - telnyx_api_unavailable - rate_limit_exceeded - whatsapp_rate_limited - resource_already_exists - test_app_required - call_not_found - call_already_ended - call_failed - call_rejected - call_timeout - call_busy - calling_not_configured - calling_disabled - max_concurrent_calls_reached - recording_not_found - recording_already_in_progress - recording_failed - voicemail_not_found - voicemail_disabled - invalid_call_command - command_not_applicable - whatsapp_calling_not_enabled - whatsapp_call_permission_required - whatsapp_call_permission_limit - whatsapp_pstn_bridge_forbidden - livekit_api_error - livekit_room_error - sip_trunk_error description: A machine-readable error code for programmatic handling example: invalid_phone_number message: type: string description: Human-readable error message example: The phone number "+1abc" is not in E.164 format. doc_url: type: string format: uri description: URL to documentation for this error code example: >- https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number param: type: string description: The parameter that caused the error example: from provider: $ref: '#/components/schemas/ProviderError' additional_info: type: array items: type: string description: Human-readable remediation hints (e.g. from Meta Health Status). required: - type - message required: - error WhatsAppPhoneNumberBusinessProfile: type: - object - 'null' properties: id: type: string metaWabaId: type: string businessName: type: - string - 'null' required: - id - metaWabaId - businessName description: The WhatsApp Business Account (WABA) this phone number belongs to WhatsAppPhoneNumberAppAssociation: type: object properties: appId: type: string appName: type: string appSlug: type: string required: - appId - appName - appSlug ProviderError: type: object properties: source: type: string enum: - meta - telnyx - livekit description: Provider name example: meta code: anyOf: - type: number - type: string description: Provider's native error code message: type: string description: Provider's error message fbtrace_id: type: string description: Meta's trace ID for support tickets health_status: $ref: '#/components/schemas/HealthStatusPayload' required: - source - code - message HealthStatusPayload: type: object properties: can_send_message: type: string enum: - AVAILABLE - LIMITED - BLOCKED description: Meta Health Status value entities: type: array items: $ref: '#/components/schemas/HealthStatusEntity' required: - can_send_message - entities description: >- Meta Health Status payload, present when the error was enriched via the Health Status API. HealthStatusEntity: oneOf: - type: object properties: entity_type: type: string enum: - PHONE_NUMBER - MESSAGE_TEMPLATE - WABA - BUSINESS - APP id: type: string can_send_message: type: string enum: - AVAILABLE can_receive_call_sip: type: string enum: - AVAILABLE - LIMITED - BLOCKED description: Meta Health Status value errors: type: array items: $ref: '#/components/schemas/HealthStatusError' required: - entity_type - id - can_send_message - type: object properties: entity_type: type: string enum: - PHONE_NUMBER - MESSAGE_TEMPLATE - WABA - BUSINESS - APP id: type: string can_send_message: type: string enum: - LIMITED can_receive_call_sip: type: string enum: - AVAILABLE - LIMITED - BLOCKED description: Meta Health Status value additional_info: type: array items: type: string errors: type: array items: $ref: '#/components/schemas/HealthStatusError' required: - entity_type - id - can_send_message - additional_info - type: object properties: entity_type: type: string enum: - PHONE_NUMBER - MESSAGE_TEMPLATE - WABA - BUSINESS - APP id: type: string can_send_message: type: string enum: - BLOCKED can_receive_call_sip: type: string enum: - AVAILABLE - LIMITED - BLOCKED description: Meta Health Status value errors: type: array items: $ref: '#/components/schemas/HealthStatusError' required: - entity_type - id - can_send_message - errors HealthStatusError: type: object properties: error_code: type: number error_description: type: string possible_solution: type: string required: - error_code - error_description - possible_solution securitySchemes: adminAuth: type: http scheme: bearer description: 'Admin API key (format: sk_admin_*) for organization-level operations' ````