/partner-api/ticketsCreate ticket
Explore the create ticket endpoint, including request parameters and response details.
Parameters
1 parameterbodypartnerTicketCreatePublicInputrequiredCommon partner ticket fields. The underlying API may accept additional work order fields.
partnerIdintegerrequiredPartner ID, which must match the authenticated partner.
brandIdintegerrequiredID of an accessible brand.
incidentUrlstringoptionalIncident URL; for social media impersonation, provide social platform and account information instead when applicable.
typestringrequiredTicket type.
descriptionstringrequiredTicket description. The current gateway schema marks this field required.
requesterEmailstringoptionalTicket requester email address.
socialPlatformstringoptionalSocial media platform for a social media impersonation ticket.
platformNamestringoptionalCustom platform name when socialPlatform is other.
socialAccountstringoptionalImpersonated social media account ID.
socialAccountNamestringoptionalImpersonated social media account name.
Responses
Successful responsesresponsepartnerTicketAuditoptionalcreatedAtstringoptionalCreated date
createdBystringoptionalCreated by user Id
updatedAtstringoptionalLast updated date
updatedBystringoptionalLast updated by user Id
workOrderIdintegeroptionalfreshdeskIdintegernulloptionalexternalSystemstringnulloptionalexternalIdstringnulloptionalbrandIdintegeroptionalbrandpartnerBrandNameoptionalbrandIdintegeroptionaloriginalNamestringoptionalBrand name in its original language.
englishNamestringoptionaltypestringoptionalsubjectstringoptionaldescriptionstringoptionalrequesterEmailstringoptionalstatusIdintegeroptionalpartnerIdintegeroptionalincidentUrlstringnulloptionaleffectiveUrlstringnulloptionaldomainRegistrarstringnulloptionalispstringnulloptionalasnstringnulloptionalipAddressesstringnulloptionalgeolocationstringnulloptionalnameServerstringnulloptionalsocialPlatformstringintegernulloptionalplatformNamestringnulloptionalsocialAccountstringnulloptionalsocialAccountNamestringnulloptionalfalseReportCompanystringnulloptionalfalseReportUrlstringnulloptionalengineNamestringnulloptionalengineVersionstringnulloptionalappNamestringnulloptionalappPathstringnulloptionalappSHA256stringnulloptionaldetectResultstringnulloptionalfalseReportSourcestringnulloptionalartworkOwnershipstringnulloptionalleakagestringnulloptionalfreshdeskCreatedAtstringoptionalfreshdeskUpdatedAtstringoptionalstatusUpdatedAtstringoptionalreopenedAtstringoptionalresolvedAtstringoptionalclosedAtstringoptionalpendingSincestringoptionalpartnerAttachmentsstring,object[]optionaltagstagInput[]optionalnamestringrequiredtypestringrequiredsubTypestringnulloptionalscopesstring[]optionalvisibilitystringoptionaldescriptionstringnulloptionalpartnerIdintegernulloptionalprocessingTimeintegeroptionalresponsepartnerTicketAuditoptionalcreatedAtstringoptionalCreated date
createdBystringoptionalCreated by user Id
updatedAtstringoptionalLast updated date
updatedBystringoptionalLast updated by user Id
workOrderIdintegeroptionalfreshdeskIdintegernulloptionalexternalSystemstringnulloptionalexternalIdstringnulloptionalbrandIdintegeroptionalbrandpartnerBrandNameoptionalbrandIdintegeroptionaloriginalNamestringoptionalBrand name in its original language.
englishNamestringoptionaltypestringoptionalsubjectstringoptionaldescriptionstringoptionalrequesterEmailstringoptionalstatusIdintegeroptionalpartnerIdintegeroptionalincidentUrlstringnulloptionaleffectiveUrlstringnulloptionaldomainRegistrarstringnulloptionalispstringnulloptionalasnstringnulloptionalipAddressesstringnulloptionalgeolocationstringnulloptionalnameServerstringnulloptionalsocialPlatformstringintegernulloptionalplatformNamestringnulloptionalsocialAccountstringnulloptionalsocialAccountNamestringnulloptionalfalseReportCompanystringnulloptionalfalseReportUrlstringnulloptionalengineNamestringnulloptionalengineVersionstringnulloptionalappNamestringnulloptionalappPathstringnulloptionalappSHA256stringnulloptionaldetectResultstringnulloptionalfalseReportSourcestringnulloptionalartworkOwnershipstringnulloptionalleakagestringnulloptionalfreshdeskCreatedAtstringoptionalfreshdeskUpdatedAtstringoptionalstatusUpdatedAtstringoptionalreopenedAtstringoptionalresolvedAtstringoptionalclosedAtstringoptionalpendingSincestringoptionalpartnerAttachmentsstring,object[]optionaltagstagInput[]optionalnamestringrequiredtypestringrequiredsubTypestringnulloptionalscopesstring[]optionalvisibilitystringoptionaldescriptionstringnulloptionalpartnerIdintegernulloptionalprocessingTimeintegeroptional