Enabling smsOptIn

Forum for users and developers of Bullhorn's API service.

Moderators: StaffingSupport, s.emmons, BullhornSupport

Post Reply
Posts: 41
Joined: Tue Oct 11, 2016 1:26 pm

Enabling smsOptIn

Post by Kazemi » Wed May 23, 2018 7:56 pm

We are querying for the "smsOptIn" flag on Candidates by hitting the search endpoint, but the field doesn't exist on the returned Candidates.

We don't see it in the UI either.

1. How do we enable it for everyone so the field is returned when we GET candidates?
2. How do we enable it to show up in the UI so we can write the field?


Posts: 46
Joined: Mon Aug 15, 2016 9:57 am

Re: Enabling smsOptIn

Post by DanJSupport » Wed Jun 20, 2018 10:28 am

Hi Kazemi,

The field should return in your search if you are including it in the fields parameter. For example, this call:

Code: Select all

GET/ search/Candidate?query=dateAdded:[20180606050000 TO 20180621045959] &fields=id,name,smsOptIn
Returns this

Code: Select all

    "total": 1,
    "start": 0,
    "count": 1,
    "data": [
            "id": 274077,
            "name": "John Smith",
            "smsOptIn": true,
            "_score": 1
If you are not seeing the smsOptIn field when making the call, can you please email me the API username you are using and I can investigate.

The field can be unhidden in the field mappings and placed on the record overview with the view layout tool. However this is a read-only field as it is tied to our Bullhorn SMS feature.

A request can be made with Bullhorn Support to mass opt in records that may have been created with this field set to false. However, once a candidate or contact has opted out by replying STOP, they can only be opted back in by replying START.
Dan Johnson
Tier 2 / Enterprise Support
Bullhorn Support US: 617-478-9126
Bullhorn Support UK: 44 800 032 2848
Bullhorn Support Australia: 61 28 073 5089
Bullhorn Support International: 617-478-9131

Post Reply