> ## Documentation Index > Fetch the complete documentation index at: https://docs.lazyapp.in/llms.txt > Use this file to discover all available pages before exploring further. # Register the number > Registers the number on the Cloud API with its two-step PIN (or sets a new PIN on a number that has none). Also required after Meta approves a new display name. Meta allows 10 register or deregister calls per number in 72 hours. **Required scope:** `connections:write` ## OpenAPI ````yaml /api-reference/openapi.json post /v1/connections/{connection}/register openapi: 3.1.0 info: title: LazyApp API version: v1 description: >- One WhatsApp API for developers, SaaS platforms and businesses. Every endpoint is Bearer-authenticated with a LazyApp API key, returns JSON, and is scoped to the workspace and mode (`live` or `test`) the key belongs to. Live keys need the Pro plan. A live key on a workspace below Pro gets `402` with `code: plan_limit_reached` on every request. Test keys work on every plan, so you can build against the test number before you upgrade. LazyApp adds 0% to Meta's message rates. Meta bills each message to the business's own Meta payment method; your LazyApp plan is billed separately. contact: name: LazyApp support url: https://lazyapp.in servers: - url: https://lazyapp.in description: Production security: - bearerAuth: [] tags: - name: Messages description: Send and schedule WhatsApp messages. - name: Contacts description: The people you message, and their identifiers. - name: Conversations description: Threads and their message history. - name: Calls description: WhatsApp call history for the workspace. - name: Templates description: Create, submit and sync message templates. - name: Media description: Upload, retrieve and delete media. - name: Broadcasts description: Template sends to many contacts at once. - name: Events description: Say what happened; LazyApp picks the template. - name: Flows description: WhatsApp Flows and their responses. - name: Webhooks description: Register endpoints and inspect deliveries. - name: Workflows description: Automations and their executions. - name: Verify description: One-time passcodes over WhatsApp. - name: Capabilities description: What each connected number supports. - name: Catalog description: Proxy Meta Commerce catalog products for a connection. - name: Platform description: Manage customers if you run a platform on LazyApp. - name: Meta-compatible proxy description: Drop-in endpoints for existing Cloud API integrations. - name: Connections description: >- Your WhatsApp numbers and the account behind them: health, limits, registration, display name, blue tick, QR codes, conversation starters, opt-in links, business profile and blocked users. - name: Billing description: >- Meta's message rates, which LazyApp passes on with 0% added, and the billing facts behind them. - name: Analytics description: Workspace messaging aggregates. - name: Groups description: WhatsApp group chats on a connection Meta has enabled. - name: Funding description: Local funding status and recorded WhatsApp charges. - name: Connections description: 'WhatsApp connections: block users, business profile, insights.' - name: Payments description: >- WhatsApp payments in India: ask for payment, follow it, update the order and refund. paths: /v1/connections/{connection}/register: post: tags: - Connections summary: Register the number description: >- Registers the number on the Cloud API with its two-step PIN (or sets a new PIN on a number that has none). Also required after Meta approves a new display name. Meta allows 10 register or deregister calls per number in 72 hours. **Required scope:** `connections:write` parameters: - name: connection in: path required: true schema: type: string format: uuid description: The connection `uuid`. requestBody: required: true content: application/json: schema: type: object required: - pin properties: pin: type: string pattern: ^\d{6}$ example: '212834' responses: '200': description: Registered. content: application/json: schema: $ref: '#/components/schemas/Connection' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/Error' '402': $ref: '#/components/responses/PlanLimitReached' '403': description: >- The key lacks the required scope, or is restricted from this phone number. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not found in this workspace. content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation failed, or Meta refused the change (see `meta`). content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/MetaRefusal' '429': description: 'Rate limit exceeded: yours, or Meta’s (`code: meta_rate_limited`).' content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/MetaRefusal' '503': description: >- Meta is temporarily unavailable (`code: meta_unavailable`). Retry later. content: application/json: schema: $ref: '#/components/schemas/MetaRefusal' components: schemas: Connection: type: object properties: uuid: type: string format: uuid phone_number_id: type: string example: '106540352242922' display_phone_number: type: string example: '+919812345670' verified_name: type: - string - 'null' description: Display name customers see. waba_id: type: string description: WhatsApp Business Account (Meta’s Messaging account) id. messaging_account_id: type: - string - 'null' mode: type: string enum: - live - test is_default: type: boolean status: type: string enum: - active - attention_required - disconnected - revoked - phone_registration_pending - signup_started - code_exchange_pending - asset_discovery - webhook_subscription_pending - authorization_received - draft connected_via: type: - string - 'null' enum: - embedded_signup - manual - platform_sync - platform_claim - null coexistence: type: boolean description: Also used in the WhatsApp Business app (fixed 20 messages a second). quality_rating: type: - string - 'null' example: GREEN messaging_limit: type: - string - 'null' example: TIER_2K description: Shared by every number in the business portfolio. throughput_level: type: - string - 'null' example: STANDARD code_verification_status: type: - string - 'null' example: VERIFIED registration_status: type: - string - 'null' enum: - registered - deregistered - pending - null two_step_pin_set: type: boolean marketing_messages_status: type: - string - 'null' created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time Error: type: object properties: message: type: string description: Human-readable description of what went wrong. code: type: string description: >- Stable machine-readable reason, when the failure is one a client can branch on. required: - message ValidationError: type: object properties: message: type: string errors: type: object additionalProperties: type: array items: type: string description: Field name to list of failures. required: - message MetaRefusal: type: object description: >- Meta refused or could not complete a change. `message` is a plain sentence you can show to people; `meta` keeps Meta’s own code for logs and support. properties: code: type: string enum: - meta_rejected - meta_permission_missing - meta_rate_limited - meta_unavailable - connection_token_expired message: type: string example: >- This number was registered or deregistered too many times. Meta blocks further attempts for 72 hours. meta: type: object properties: code: type: - integer - 'null' example: 133016 message: type: - string - 'null' fbtrace_id: type: - string - 'null' required: - code - message - meta responses: PlanLimitReached: description: >- The workspace's plan does not allow this. A live key on a workspace below Pro gets this on every request, because the live API is a Pro feature. Upgrade in **Billing** to use live keys. Test keys are never limited, on any plan. `code` is always `plan_limit_reached`. Show `message` to the person: it names the plan to move to. Other plan limits use the same code in the console, but the API reports them differently today: a broadcast larger than the month's remaining Live broadcast sends is refused with `422` and the reason in `message`, and connecting a number beyond the plan's number capacity fails validation (`422`) on `phone_number_id`. content: application/json: schema: type: object properties: message: type: string description: >- A sentence you can show to the person. Says which plan to move to. code: type: string enum: - plan_limit_reached required: - message - code example: message: >- The API is on the Pro plan. Upgrade in Billing to use live keys. Test keys keep working. code: plan_limit_reached securitySchemes: bearerAuth: type: http scheme: bearer description: Your API key, e.g. `sk_live_...` or `sk_test_...`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.