OBO Mobility Intent

Create OBO Mobility Intent

Create a new On-Behalf-Of mobility intent for a WhatsApp Business Account. This endpoint allows authorized solution providers to initiate mobility operations on behalf of business accounts, facilitating transfers and handovers between different solution providers.

Use Cases:

  • Initiate account mobility process between solution providers
  • Request handover of account management
  • Schedule mobility operations for future execution
  • Coordinate multi-partner solution transitions

Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.

Mobility Process:

  1. Create mobility intent with appropriate intent type
  2. System validates mobility eligibility and permissions
  3. Intent enters PENDING status awaiting approvals
  4. Partner notifications and approval workflows are triggered
  5. Upon approval, mobility operation is scheduled or executed
  6. Status updates are provided throughout the process
post/{Version}/{WABA-ID}/obo_mobility_intent

Request

  • Base URL
    https://graph.facebook.com
  • URL
    https://graph.facebook.com/{Version}/{WABA-ID}/obo_mobility_intent
  • Auth
    HTTP bearer

Path parameters

Versionstring required

Graph API version to use for this request. Determines the API behavior and available features.

WABA-IDstring required

WhatsApp Business Account ID. This ID identifies the WABA for which the OBO mobility intent is being created.

Headers

User-Agentstring
Example:Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21

The user agent string identifying the client software making the request.

Authorizationstring required
Example:Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...

Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

Request body

solution_idstring required

Unique identifier for the WhatsApp Business Solution

intent_type'INITIATE_TRANSFER' | 'CONFIRM_TRANSFER' | 'CANCEL_TRANSFER' | 'REQUEST_HANDOVER' | 'APPROVE_HANDOVER' | 'REJECT_HANDOVER' required

Type of mobility intent operation

target_solution_idstring

Target solution ID for mobility operations (required for transfers)

mobility_reasonstring

Reason for the mobility intent

scheduled_execution_timestring date-time

Scheduled time for mobility execution (ISO 8601 format)

metadataobject

Additional metadata for the mobility operation

Example request

{
  "solution_id": "2345678901234567",
  "intent_type": "INITIATE_TRANSFER",
  "target_solution_id": "3456789012345678",
  "mobility_reason": "Transferring account management to new solution provider",
  "scheduled_execution_time": "2024-12-01T10:00:00Z",
  "metadata": {
    "partner_approval_id": "approval_123456",
    "business_justification": "Business restructuring"
  }
}

Response

Successfully created OBO mobility intent

successboolean required

Indicates if the mobility intent operation was successful

mobility_intent_idstring required

Unique identifier for the mobility intent request

status'PENDING' | 'APPROVED' | 'REJECTED' | 'SCHEDULED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'

Current status of the mobility intent

estimated_completion_timestring date-time

Estimated completion time for the mobility operation (ISO 8601 format)

approval_requiredboolean

Indicates if additional approval is required for the operation

next_stepsstring[]

List of next steps required to complete the mobility operation

Example response

{
  "success": true,
  "mobility_intent_id": "obo_mobility_123456789",
  "status": "PENDING",
  "estimated_completion_time": "2024-12-01T12:00:00Z",
  "approval_required": true,
  "next_steps": [
    "Await partner approval",
    "Confirm transfer details"
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.