{
"about": "ABOUT",
"ycloudName": "Support line",
"verifiedName": "verifiedName",
"nameStatus": "APPROVED",
"newName": "John's Cake",
"newNameStatus": "APPROVED",
"address": "ADDRESS",
"description": "DESCRIPTION",
"email": "tom@example.com",
"profilePictureUrl": "https://URL",
"vertical": "OTHER",
"websites": [
"https://WEBSITE-1"
]
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Retrieve a phone number profile
Retrieves a WhatsApp business phone number’s profile. Customers can view your business profile by clicking your business’s name or number in a conversation thread.
{
"about": "ABOUT",
"ycloudName": "Support line",
"verifiedName": "verifiedName",
"nameStatus": "APPROVED",
"newName": "John's Cake",
"newNameStatus": "APPROVED",
"address": "ADDRESS",
"description": "DESCRIPTION",
"email": "tom@example.com",
"profilePictureUrl": "https://URL",
"vertical": "OTHER",
"websites": [
"https://WEBSITE-1"
]
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Path Parameters
WhatsApp Business Account ID.
"whatsapp-business-account-id"
Response
Successfully retrieved the object.
WhatsApp Phone Number Business Profile. Customers can view your business profile by clicking your business's name or number in a conversation thread.
The business's About text. This text appears in the business's profile, beneath its profile image, phone number, and contact buttons.
"ABOUT"
Optional remark name assigned to this phone number in YCloud. It is populated by the profile GET API and omitted when no remark name is set.
"Support line"
The verified name
"verifiedName"
The review status of the current display name request. See also Get Display Name Status.
APPROVED: The name has been approved. You can download your certificate now.AVAILABLE_WITHOUT_REVIEW: The certificate for the phone is available and display name is ready to use without review.DECLINED: The name has not been approved. You cannot download your certificate.EXPIRED: Your certificate has expire and can no longer be downloaded.PENDING_REVIEW: Your name request is under review. You cannot download your certificate.NONE: No certificate is available.
APPROVED, AVAILABLE_WITHOUT_REVIEW, DECLINED, EXPIRED, PENDING_REVIEW, NONE The modified name
"John's Cake"
The review status of the current display name request. See also Get Display Name Status.
APPROVED: The name has been approved. You can download your certificate now.AVAILABLE_WITHOUT_REVIEW: The certificate for the phone is available and display name is ready to use without review.DECLINED: The name has not been approved. You cannot download your certificate.EXPIRED: Your certificate has expire and can no longer be downloaded.PENDING_REVIEW: Your name request is under review. You cannot download your certificate.NONE: No certificate is available.
APPROVED, AVAILABLE_WITHOUT_REVIEW, DECLINED, EXPIRED, PENDING_REVIEW, NONE Address of the business. Character limit 256.
256"ADDRESS"
Description of the business. Character limit 512.
512"DESCRIPTION"
The contact email address (in valid email format) of the business. Character limit 128.
128"tom@example.com"
URL of the profile picture used to upload to Meta.
"https://URL"
Industry of the WhatsApp phone number business profile. This can be either an empty string or one of the accepted values.
OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH, NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, RESTAURANT "OTHER"
The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http:// or https:// portion of the URL. There is a maximum of 2 websites with a maximum of 255 characters each.
2255