Create Brand

POST {{baseUrl}}/api/v2/brands

Allowed for

  • Admins

Request Body

{"brand"=>{"name"=>"<string>", "subdomain"=>"<string>", "active"=>"<boolean>", "brand_url"=>"<string>", "default"=>"<boolean>", "has_help_center"=>"<boolean>", "host_mapping"=>"<string>", "is_deleted"=>"<boolean>", "logo"=>{"value"=>"<Error: Too many levels of nesting to fake this schema>"}, "signature_template"=>"<string>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;brand&quot;:{&quot;active&quot;:true,&quot;brand_url&quot;:&quot;https://brand1.zendesk.com&quot;,&quot;created_at&quot;:&quot;2019-08-06T02:43:39Z&quot;,&quot;default&quot;:true,&quot;has_help_center&quot;:true,&quot;help_center_state&quot;:&quot;enabled&quot;,&quot;host_mapping&quot;:&quot;brand1.com&quot;,&quot;id&quot;:360002783572,&quot;is_deleted&quot;:false,&quot;logo&quot;:{&quot;content_type&quot;:&quot;image/png&quot;,&quot;content_url&quot;:&quot;https://company.zendesk.com/logos/brand1_logo.png&quot;,&quot;file_name&quot;:&quot;brand1_logo.png&quot;,&quot;id&quot;:928374,&quot;mapped_content_url&quot;:&quot;https://company.com/logos/brand1_logo.png&quot;,&quot;size&quot;:166144,&quot;thumbnails&quot;:[{&quot;content_type&quot;:&quot;image/png&quot;,&quot;content_url&quot;:&quot;https://company.zendesk.com/photos/brand1_logo_thumb.png&quot;,&quot;file_name&quot;:&quot;brand1_logo_thumb.png&quot;,&quot;id&quot;:928375,&quot;mapped_content_url&quot;:&quot;https://company.com/photos/brand1_logo_thumb.png&quot;,&quot;size&quot;:58298,&quot;url&quot;:&quot;https://company.zendesk.com/api/v2/attachments/928375.json&quot;},{&quot;content_type&quot;:&quot;image/png&quot;,&quot;content_url&quot;:&quot;https://company.zendesk.com/photos/brand1_logo_small.png&quot;,&quot;file_name&quot;:&quot;brand1_logo_small.png&quot;,&quot;id&quot;:928376,&quot;mapped_content_url&quot;:&quot;https://company.com/photos/brand1_logo_small.png&quot;,&quot;size&quot;:58298,&quot;url&quot;:&quot;https://company.zendesk.com/api/v2/attachments/928376.json&quot;}],&quot;url&quot;:&quot;https://company.zendesk.com/api/v2/attachments/928374.json&quot;},&quot;name&quot;:&quot;Brand 1&quot;,&quot;signature_template&quot;:&quot;{{agent.signature}}&quot;,&quot;subdomain&quot;:&quot;hello-world&quot;,&quot;ticket_form_ids&quot;:[360000660811],&quot;updated_at&quot;:&quot;2019-08-06T02:43:40Z&quot;,&quot;url&quot;:&quot;https://company.zendesk.com/api/v2/brands/360002783572.json&quot;}}