Mutation
mutation DeleteCompany($input: DeleteCompanyInput!) {
deleteCompany(input: $input) {
company {
id
name
logoUrl
domainName
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"companyIdentifier": {}
}
}Response
{
"data": {
"deleteCompany": {
"company": {
"id": "id",
"name": "string",
"logoUrl": "string",
"domainName": "string",
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
deleteCompany
Deletes a company identified by companyId or companyDomainName. Deleting a company unlinks it from all of its customers — the customers themselves are not deleted. Requires the company:delete permission.
MUTATION
deleteCompany(input: DeleteCompanyInput!): DeleteCompanyOutput!Arguments
input
required
Returns
company
error
Mutation
mutation DeleteCompany($input: DeleteCompanyInput!) {
deleteCompany(input: $input) {
company {
id
name
logoUrl
domainName
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"companyIdentifier": {}
}
}Response
{
"data": {
"deleteCompany": {
"company": {
"id": "id",
"name": "string",
"logoUrl": "string",
"domainName": "string",
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

