Set Profile

Set Profile allows you to change one or multiple settings within your WhatsApp account.


More Remarks

  • None of the parameters is mandatory. you can set only the need.

  • You can't change or set the profile settings for Coexistence WhatsApp accounts. the profile can only be changed directly by the client in the mobile app.


Settings:

URL

https://api.99digital.co.il/whatsapp/v2/setProfile

Method

JSON via POST

Header

Key

Value

apiKey

Your API key for the service


Body:

Parameter

Description / Example

Maximum length

Remarks

from

your WhatsApp account. international number without +. for example: 972771234567



address

The address of your business

\n for new line

text for bold

text for italic

~text~ for strike through

256

if you need to clear this data, you can send " " (space)

description

Description of your business

\n for new line

text for bold

text for italic

~text~ for strike through

256

if you need to clear this data, you can send " " (space)

email

example@website.com

128

must be valid email format. if you need to clear this data, you can send " " (space)

type

you must choose a business category type

1 - Automotive

2 - Beauty, Spa and Salon

3 - Clothing and Apparel

4 - Education

5 - Entertainment

6 - Event Planning and Service

7 - Finance and Banking

8 - Food and Grocery

9 - Public Service / Government

10 - Hotel and Lodging

11 - Medical and Health

12 - Non-profit Organization

13 - Professional Services

14 - Shopping and Retail

15 - Travel and Transportation

16 - Restaurant

17 - Other

2

This parameter can be changed, but cannot be empty.

website

https://www.example.com

256

must be valid website format. if you need to clear this data, you can send " " (space). must include http or https. value can be business website, Facebook page, Instagram, youtube link etc.

profilePic

https://www.alchinlong.com/wp-content/uploads/2015/09/sample-profile-320x320.png

-

must be jpeg/jpg/png image link, URL must be https.

the image needs to be square with max edge of 640px and maximum 5MB file size.

it is recommended to use 640x640,

images less than 192px will not be approved.

about

"Hi There, I'm using WhatsApp"

139

About section in the business profile. Can't be empty.

displayName

My New WhatsApp Name

75

This is the WhatsApp number display name change. few points for you to know:

  • Minimum 3 characters, maximum 75 characters.

  • Name will be sent to Meta to approve. you can update from the getProfile to see if the name has been approved (or you can see from WhatsApp directly). it can take around 2-4 days.

  • The name must be similar as much as possible to your business name, or Met will reject it.

  • You can request a name change 10 times during 30 days.

  • If your WhatsApp number has green/blue official checkmark, this will not work and you must contact support to change for those.

  • This will not work for coexistence WhatsApp accounts , as they can change the displayName directly on the mobile phone.

  • dont include this parameter if you dont wish to change it.

  • If a request is sent, you can't request again until the new name is either approved or rejected. wait a few days between requests.


Response:


{
"status": "OK",
"address": "The address you provided",
"reason": 1
}


Response-Explain:

Parameter

Description

status

OK or FAIL

returnedData

An object that will show all the parameters you sent

(address, description,email, type, website, about, profilePic)

reason

'reason' is the status explanation in case of FAIL

1

not FAIL. the status is OK

2

Your "from" number account does not exist or invalid JSON

3

wrong apiKey

4

'address' is too long

5

'description' is too long

6

'email' is too long, or invalid email address

7

'type' must be integer from 1 to 17

8

'website' is too long or invalid website address

10

'profilePic' URL is invalid

11

'about' is invalid or too long

12

Uknown error - please contact support

13

displayName value is invalid or wrong.

14

displayName received an error on Meta side, other profile settings (if sent) were saved successfully.