Skip to main content
POST
Updates the key settings of a business: name, size, location, logo and outgoing email configuration.

Path parameters

integer
required
ID of the business to update.

Query parameters

string
required
Website URL of the business, for example https://www.your-domain.com. Required, but it cannot be changed after the business is created.
string
required
Official business name, shown on the platform.
integer
required
Country ID — the value field from Get countries.
string
required
One of small, medium, large, very_large.
boolean
Nullable. true or false.
Nullable. Logo path returned by Upload a logo, for example /images/logo.png.

Email settings

These parameters configure the email account the business uses to send messages.
string
Mailer protocol, for example smtp.
string
Host address of the mail server, for example smtp.yourmailprovider.com.
integer
Mail server port, for example 587 for TLS or 465 for SSL.
string
Encryption protocol, for example TLS or SSL.
string
Username used to authenticate with the mail server.
string
Password for the mail account.
string
Display name for outgoing emails.
string
Address outgoing emails are sent from, for example [email protected].

Response

boolean
true when the business is updated.
integer
1 when the update succeeds.