Remove the customer portal favicon

DELETE/v1/api/store/{team_slug}/setting/customer_portal_favicon

v1Operation ID v1_public_setting_customer_portal_favicon_delete

Removes the customer portal favicon. The company details then read favicon_url: null. Calling it when there is none also succeeds. The response has no data.

Permission

Needs the Manage Settings permission. The team owner always has it.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• POSTUpload the customer portal favicon/v1/api/store/{team_slug}/setting/customer_portal_favicon
• GETGet your company details/v1/api/store/{team_slug}/setting/detail

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/setting/customer_portal_favicon' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}