Mutation
mutation LeadDelete($id: String!) {
leadDelete(id: $id) {
deletedLeadId
userErrors {
code
field
message
}
}
}Variables
{
"id": "string"
}Response
{
"data": {
"leadDelete": {
"deletedLeadId": "string",
"userErrors": [
{
"code": "string",
"field": [
"string"
],
"message": "string"
}
]
}
}
}Mutations
leadDelete
Delete (archive) a lead
Soft deletes the lead by setting status to "unqualified".
@example ```graphql
mutation {
leadDelete(id: "lead_id") {
deletedLeadId
userErrors {
message
}
}
}
```
MUTATION
leadDelete(id: String!): LeadDeletePayload!Arguments
id
String!
required
Returns
deletedLeadId
String
userErrors
[UserError!]!
Mutation
mutation LeadDelete($id: String!) {
leadDelete(id: $id) {
deletedLeadId
userErrors {
code
field
message
}
}
}Variables
{
"id": "string"
}Response
{
"data": {
"leadDelete": {
"deletedLeadId": "string",
"userErrors": [
{
"code": "string",
"field": [
"string"
],
"message": "string"
}
]
}
}
}