Skip to content

Submit the contact form

POST
/api/v1/business/website/contact/

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)

Request Body

application/json
JSON
{
  
"name": "string",
  
"email": "string",
  
"phone": "string",
  
"subject": "string",
  
"message": "string",
  
"metadata": {
  
  
"additionalProperties": "string"
  
}
}

Responses

Message stored.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"id": 0,
  
  
"name": "string",
  
  
"email": "string",
  
  
"phone": "string",
  
  
"subject": "string",
  
  
"message": "string",
  
  
"metadata": {
  
  
},
  
  
"is_read": true,
  
  
"created_at": "string"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale