Mutation
mutation LeadCreate($input: LeadCreateInputInput!) {
leadCreate(input: $input) {
lead {
assignee {
email
id
name
user {
__typename
}
}
attribution
company
completedCallCount
consent {
agreed
at
disclosure
grantedAt
id
kind
}
consentByType {
dataProcessing {
__typename
}
emailMarketing {
__typename
}
smsBooking {
__typename
}
smsMarketing {
__typename
}
}
}
userErrors {
code
field
message
}
}
}Variables
{
"input": {
"email": "string"
}
}Response
{
"data": {
"leadCreate": {
"lead": {
"assignee": {
"email": "string",
"id": "string",
"name": "string",
"user": {
"__typename": "User"
}
},
"attribution": "value",
"company": "string",
"completedCallCount": "value",
"consent": [
{
"agreed": true,
"at": "string",
"disclosure": "string",
"grantedAt": "string",
"id": "string",
"kind": "aura_sms"
}
],
"consentByType": {
"dataProcessing": {
"__typename": "ConsentTypeAnswer"
},
"emailMarketing": {
"__typename": "ConsentTypeAnswer"
},
"smsBooking": {
"__typename": "ConsentTypeAnswer"
},
"smsMarketing": {
"__typename": "ConsentTypeAnswer"
}
}
},
"userErrors": [
{
"code": "string",
"field": [
"string"
],
"message": "string"
}
]
}
}
}Mutations
leadCreate
Create a new lead
Follows Shopify pattern: leadCreate (not createLead)
With an API key, Aura records which key created the lead and shows that key's name on the lead's page in the app, so name each key after the tool that uses it.
@example ```graphql
mutation {
leadCreate(input: { email: "john@example.com", name: "John Doe" }) {
lead {
id
name
email
status
}
userErrors {
message
field
code
}
}
}
```
MUTATION
leadCreate(input: LeadCreateInputInput!): LeadCreatePayload!Arguments
input
required
Returns
lead
userErrors
[UserError!]!
Mutation
mutation LeadCreate($input: LeadCreateInputInput!) {
leadCreate(input: $input) {
lead {
assignee {
email
id
name
user {
__typename
}
}
attribution
company
completedCallCount
consent {
agreed
at
disclosure
grantedAt
id
kind
}
consentByType {
dataProcessing {
__typename
}
emailMarketing {
__typename
}
smsBooking {
__typename
}
smsMarketing {
__typename
}
}
}
userErrors {
code
field
message
}
}
}Variables
{
"input": {
"email": "string"
}
}Response
{
"data": {
"leadCreate": {
"lead": {
"assignee": {
"email": "string",
"id": "string",
"name": "string",
"user": {
"__typename": "User"
}
},
"attribution": "value",
"company": "string",
"completedCallCount": "value",
"consent": [
{
"agreed": true,
"at": "string",
"disclosure": "string",
"grantedAt": "string",
"id": "string",
"kind": "aura_sms"
}
],
"consentByType": {
"dataProcessing": {
"__typename": "ConsentTypeAnswer"
},
"emailMarketing": {
"__typename": "ConsentTypeAnswer"
},
"smsBooking": {
"__typename": "ConsentTypeAnswer"
},
"smsMarketing": {
"__typename": "ConsentTypeAnswer"
}
}
},
"userErrors": [
{
"code": "string",
"field": [
"string"
],
"message": "string"
}
]
}
}
}