WABA Profile Info

This document describes how to manage your WABA Profile Info

In the 360dialog Client Hub

You can update your WABA profile information in the 360dialog Client Hub.

In the API

If the WABA is registered in On-premise API

You can use the following endpoints to set your WhatsApp profile info in the same manner as described in the official WhatsApp documentation on the topic.

Profile: About

GET https://[base-path]/v1/settings/profile/about

Use this edge to retrieve your profile's About section.

{
  "settings": {
    "profile": {
      "about": {
        "text": "your-profile-about-text"
      }
    }
  }

Profile: About

PATCH https://[base-path]/v1/settings/profile/about

Use this edge to manage your profile's About section.

Request Body

Name

Type

Description

text

string

{
    "meta": {
        "api_status": "stable",
        "version": "2.33.4"
    }
}

Profile: Photo

POST https://[base-path]/v1/settings/profile/photo

Use this endpoint to manage your profile photo.

Request Body

Name

Type

Description

object

Your binary image content

{
    "meta": {
        "api_status": "stable",
        "version": "2.33.4"
    }
}

Business Profile

POST https://[base-path]/v1/settings/business/profile

Use the endpoint to configure the following business profile settings: business address, business description, email for business contact, business industry, and business website.

Request Body

Name

Type

Description

vertical

array

Industry of the business.

websites

array

URLs associated with the business.

string

Business email

description

string

Description of the business. Max 256 characters.

address

string

Address of the business

{
    "meta": {
        "api_status": "stable",
        "version": "2.33.4"
    }
}

Please review the official WhatsApp docs for the full list of acceptable parameter values.

If the WABA is registered in Cloud API

You can use the following endpoints to set your WhatsApp profile info in the same manner as described in the official WhatsApp documentation on the topic.

Retrieve Business Profile information

GET https://[base-path]/whatsapp_business_profile?fields=address,description,email,profile_picture_url,websites,vertical

Use this edge to retrieve the information available in the Business Profile: business address, business description, email for business contact, business industry, and business website.

Request example

GET /whatsapp_business_profile?fields=address,description,email,profile_picture_url,websites,vertical'

Request Body

Name

Type

Description

address

string

Address of the business. Maximum of 256 characters

description

String

Description of business. Maximum of 512 characters.

String

Email address (in valid email format) to contact the business. Maximum of 128 characters.

vertical

String

Industry of the business. Must be one of these accepted values: UNDEFINED / OTHER / AUTO / BEAUTY / APPAREL / EDU / ENTERTAIN / EVENT_PLAN / FINANCE / GROCERY / GOVT / HOTEL / HEALTH / NONPROFIT / PROF_SERVICES / RETAIL / TRAVEL / RESTAURANT / NOT_A_BIZ The business vertical cannot be set back to an empty value after it is create

websites

array of strings

URLs (including http:// or https://) associated with the business (e.g., website, Facebook Page, Instagram). Maximum of 2 websites with a maximum of 256 characters each.

A successful response includes the profile object containing the business profile data.

{
  "data": [{
    "messaging_product": "whatsapp",
    "address": "ADDRESS",
    "description": "DESCRIPTION",
    "vertical": "INDUSTRY",
    "email": "EMAIL",
    "websites": [
       "https://WEBSITE-1",
       "https://WEBSITE-2"
     ],
     "profile_picture_url": PROFILE_PICTURE_HANDLE
  }]
}

Update Business Profile Information

POST https://[base-path]/whatsapp_business_profile

Use the endpoint to configure the following business profile settings: business address, business description, email for business contact, business industry, and business website.

If you only need to update a couple of fields with new information, you can make a request which changes only the necessary fields.

You can use the profile_picture_handle parameter to update the profile photo. HANDLE_OF_PROFILE_PICTURE is url obtained from the Resumable Upload API.

Request example

curl -X POST 'https://waba-v2.360dialog.io/whatsapp_business_profile' -H 'D360-API-KEY: YOUR_API_KEY' -d '{ "messaging_product": "whatsapp", "address": "ADDRESS", "description": "DESCRIPTION", "vertical": "INDUSTRY", "email": "EMAIL", "websites": [ "https://WEBSITE-1", "https://WEBSITE-2" ], "profile_picture_handle": "HANDLE_OF_PROFILE_PICTURE" }'

Request Body

Name

Type

Description

vertical

array

The business vertical cannot be set back to an empty value after it is create

websites

array

URLs associated with the business.

string

Email address (in valid email format) to contact the business. Maximum of 128 characters

description

string

Description of the business. Max 512 characters.

address

string

Address of the business. Maximum of 256 characters

{
    // Response
}

Resumable Upload API for Profile Pictures

The Resumable Upload API allows you to upload profile pictures and essentially large files to the Cloud API. Once uploaded, you can use a file's handle fetched in step 2 to update your profile_picture_handle.

Please note that to access and utilize the Resumable Upload API, it is mandatory to include the 360dialog-API-key within the header.

Step 1: Create a Session

Send a POST request that describes your file to the endpoint /uploads.Upon success, an upload session ID will be returned that you can use in the next step to initiate the upload.

Request Syntax

POST-https://waba-v2.360dialog.io/uploads
  &file_length={file-length}
  &file_type={file-type}

Parameters

Parameter

Description

file_length int64

The file length in bytes

file_type RegexParam

The MIME type of the file to be uploaded

Response

{id} — Upload session ID.

Sample Request

curl -X POST \
 "https://waba-v2.360dialog.io/uploads?file_length=109981&file_type=image/png"

Sample Response

{
    "id": "upload:MTphd..."
}

Step 2: Initiate Upload

Initiate the upload session by sending a POST request and append your upload session {id} along with the authentication header. Upon success, a file handle {h},is returned that you can then use the {h} value to update your profile picture.

Request Syntax

POST waba-v2.360dialog.io/{session_id}  
--header 'file_offset: 0'
--data-binary @{file-name}

Placeholder Values

{session_id} — Upload session ID returned in step 1.
{file-name} — Name of the file to upload.

Response

{
  "h": "{h}"
}

Response property values:

{h} — The uploaded file's file handle

Sample Request

curl -X POST \
 "https://waba-v2.360dialog.io/upload:MTphd..." \

Sample Response

{
    "h": "2:c2FtcGxl..."
}

You can then use the Update Business Profile information endpoint to update the profile photo using the {h} value.

Please review the official WhatsApp docs for the full list of acceptable parameter values.

Remember The [base-path] for Cloud API is https://waba-v2.360dialog.io. Every request to WhatsApp API needs to be authorized using API Key authentication. Adding theD360-API-KEY header with your API Key as a value will give you permission.

PreviousPartner Change NextCapacity, Quality Rating, and Messaging Limits

Last updated 2 years ago

Was this helpful?