What is the correct API Lead Source syntax?

Hello!

I’m having a problem setting the Lead Source on Leads that are created through the API.

I have altered the default source “Demand Generation” and defined “Direct”, “Web Form”, “Live Chat” and “Personal” as Lead Source Select items in the UI.

Using /api/doc and posting this data to /api/rest/latest/leads.json:

JavaScript

{ "lead":{ "name":"Example LeadPerson", "namePrefix":null, "firstName":"Example", "middleName":null, "lastName":"LeadPerson", "nameSuffix":null, "jobTitle":null, "phoneNumber":"123-321-1232", "email":"email@example.com", "companyName":null, "website":null, "numberOfEmployees":null, "industry":null, "notes":"Example of a Note", "contact":null, "owner":1, "customer":null, "dataChannel":1, "campaign":null } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

{      "lead":{         "name":"Example LeadPerson",       "namePrefix":null,       "firstName":"Example",       "middleName":null,       "lastName":"LeadPerson",       "nameSuffix":null,       "jobTitle":null,       "phoneNumber":"123-321-1232",       "email":"email@example.com",       "companyName":null,       "website":null,       "numberOfEmployees":null,       "industry":null,       "notes":"Example of a Note",       "contact":null,       "owner":1,       "customer":null,       "dataChannel":1,       "campaign":null    } }

Results in a successfully created Lead.

When I do a GET on the created lead, I get:

PHP

, { "id": 7, "name": "Example LeadPerson", "namePrefix": null, "firstName": "Example", "middleName": null, "lastName": "LeadPerson", "nameSuffix": null, "jobTitle": null, "phoneNumber": "123-321-1232", "email": "email@example.com", "companyName": null, "website": null, "numberOfEmployees": null, "industry": null, "createdAt": "2015-12-18T18:53:55+00:00", "updatedAt": "2015-12-18T19:01:02+00:00", "notes": "Example of a Note", "status": "New", "contact": null, "address": null, "owner": {}, "opportunities": {}, "workflowItem": { "__initializer__": {}, "__cloner__": {}, "__isInitialized__": false }, "workflowStep": "New", "organization": "example.dev", "customer": null, "dataChannel": "channel", "campaign": null, "source": "Direct" }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

,   {     "id": 7,     "name": "Example LeadPerson",     "namePrefix": null,     "firstName": "Example",     "middleName": null,     "lastName": "LeadPerson",     "nameSuffix": null,     "jobTitle": null,     "phoneNumber": "123-321-1232",     "email": "email@example.com",     "companyName": null,     "website": null,     "numberOfEmployees": null,     "industry": null,     "createdAt": "2015-12-18T18:53:55+00:00",     "updatedAt": "2015-12-18T19:01:02+00:00",     "notes": "Example of a Note",     "status": "New",     "contact": null,     "address": null,     "owner": {},     "opportunities": {},     "workflowItem": {       "__initializer__": {},       "__cloner__": {},       "__isInitialized__": false     },     "workflowStep": "New",     "organization": "example.dev",     "customer": null,     "dataChannel": "channel",     "campaign": null,     "source": "Direct"   }

So then I post this data to try to create a Lead with “Direct” as source:

JavaScript

{ "lead":{ "name":"Example LeadPerson", "namePrefix":null, "firstName":"Example", "middleName":null, "lastName":"LeadPerson", "nameSuffix":null, "jobTitle":null, "phoneNumber":"123-321-1232", "email":"email@example.com", "companyName":null, "website":null, "numberOfEmployees":null, "industry":null, "notes":"Example of a Note", "contact":null, "owner":1, "customer":null, "dataChannel":1, "campaign":null, "source":"Direct" } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

{      "lead":{         "name":"Example LeadPerson",       "namePrefix":null,       "firstName":"Example",       "middleName":null,       "lastName":"LeadPerson",       "nameSuffix":null,       "jobTitle":null,       "phoneNumber":"123-321-1232",       "email":"email@example.com",       "companyName":null,       "website":null,       "numberOfEmployees":null,       "industry":null,       "notes":"Example of a Note",       "contact":null,       "owner":1,       "customer":null,       "dataChannel":1,       "campaign":null,       "source":"Direct"    } }

Results in a 400 validation error saying:

JavaScript

"source": { "errors": [ "This value is not valid." ] }

1 2 3 4 5

"source": {         "errors": [           "This value is not valid."         ]       }

I have tried using integers such as

"source":1

1	"source":1

and strings like

"source":"Web Form"

1	"source":"Web Form"

and other variations of syntax but it seems that any request that includes a source parameter fails validation regardless of if the value is valid in the UI and is returned as valid in a GET request.

What am I doing wrong?

Topic

[RodolfoParticipant]

Hi,

Check your table oro_enum_lead_source

I would try to pass the value you see in “id” field. For example if you want to set “Demand Generation” it must be: “demand_generation”

[Tom HollandParticipant]

Thank you @Rodolfo !

That was the ticket. Even though I had changed Demand Generation to Direct, the Id was still demand_generation.

Interesting that varchar is used for Id vs. int. After looking at the db a bit, I see that there are also tables that don’t have an Id, just name and label although most tables do use integer Ids. I’ll keep that in mind in the future.

Thank you again,
Tom

[Author]

Replies