See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Branding >
  5. Delete Custom Message

Delete Custom Message

Early Preview

This API is in early preview and may be subject to change. Please contact your account manager if you are interested in trying the Branding API.

Use this API to delete a custom error message.

Be careful, this operation is final and can not be undone.




Resource URL

https://<api-domain>/api/2/branding/brands/<brand_id>/custom_error_messages/<message_id_>

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

In order to use the Branding API your API Credentials must be created after 21st October 2020.

Content-Type

required

string

 Set to application/json.

Resource Parameters

brand_id

required

integer | master

Unique identifier for the branding object.

message_id

required

integer

Unique identifier for the custom error message.

Sample Responses

  • 204 No Content
  • 404 Not Found

Success. The message template has been deleted. No content is returned.

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Branding API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Delete Account Brand

curl 'https://<subdomain>/api/2/branding/brands/:brand_id/templates/:template_id' \
-X DELETE \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.