Yellow.ai

App · 18 actions

Manage Yellow.ai users, events, Inbox tickets and views across supported regions.

Actions

ActionWhat it does
Add userAdd user.
Agent chat concurrencyAgent chat concurrency.
Create a ticketCreate a ticket.
Create new eventCreate new event.
Delete userDelete user.
Get user detailsGet user details.
Get user eventsGet user events.
List custom viewsList custom views.
List outbound templatesList the bot’s outbound message templates.
List ticket messagesList ticket messages.
List tickets in a viewList tickets in a view.
Mark a ticket missedMark a ticket missed.
Remove ticket tagsRemove ticket tags.
Replace ticket tagsReplace ticket tags.
Retrieve a ticketRetrieve a ticket.
Search ticketsSearch tickets.
Update a ticketUpdate a ticket.
Update userUpdate user.

Add user

Add user.

Inputs

User IDemployee_idtextRequired
Unique identifier of the user.
First namefirst_nametext
The first name of the user.
Last namelast_nametext
Last name of the user.
Gendergendertext
Gender of the user.
Countrycountrytext
Country of the user.
Citycitytext
City of the user according to the user's address.
Languagelanguagetext
Preferred language of the user.
Emailemailtext
Email address of the user.
Phonephonetext
Phone number of the user with country code.
Last channellast_channeltext
Recent channel (set up on yellow.ai) where the user had an active session. You can update this property to cover touch-points/channels outside yellow.ai.
Dobdobdate
Date of birth of the user.
Email optinemail_optintrue/false
Subscription status of the user to emails. Pass `true` to subscribe for emails, else pass `false`.
Sms optinsms_optintrue/false
Subscription status of the user to SMS. Pass `true` to subscribe the user to SMS, else pass `false`.
Whats app optinwhats_app_optintrue/false
WhatsApp subscription status of the user. Pass `true` to subscribe the user to your WhatsApp notifications, else pass `false`.
Tagstagslist
List of groups associated with the user. You can add tags to users manually.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "botId": {
        "value": "example"
      },
      "country": {
        "propertyType": "example",
        "value": "example"
      },
      "createdAt": {
        "propertyType": "example",
        "value": "example"
      },
      "emailOptIn": {
        "propertyType": "example",
        "value": false
      },
      "id": {
        "value": "example"
      },
      "lastName": {
        "propertyType": "example",
        "value": "example"
      },
      "phone": {
        "propertyType": "example",
        "value": "example"
      },
      "profileComplete": {
        "value": "example"
      },
      "tags": {
        "propertyType": "example",
        "value": []
      },
      "updatedAt": {
        "propertyType": "example",
        "value": "example"
      },
      "userId": {
        "propertyType": "example",
        "value": "example"
      }
    },
    "message": "example"
  }
}

Agent chat concurrency

Agent chat concurrency.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "agents": []
  }
}

Create a ticket

Create a ticket.

Inputs

RequesterrequesterobjectRequired
Identifies the end user. At least one of email, phone, or external_id is required; the first present (in that order) becomes the ticket uid.
SourcesourcetextRequired
Channel the ticket originates from. Required.One of: whatsapp, facebook, yellowmessenger, appleBusinessChat, email, lazada, instagram.
Subjectsubjecttext
Ticket subject text. Alias `issue` is also accepted.
Priorityprioritytext
Priority. Common aliases are mapped: normal→MEDIUM, urgent→HIGH. Accepted: LOW, MEDIUM, HIGH (or low/normal/high/urgent).One of: low, normal, high, urgent. Default: normal.
Tagstagslist
Tags to set on the ticket. Must be an array.
Categorycategorytext
Group/category code to assign. Alias `group_id` is also accepted.
Assigned toassigned_totext
Agent to assign the ticket to. Alias `assignee_id` is also accepted.
Custom fieldscustom_fieldsobject
Key-value custom fields. Keys must be configured in the bot's support settings; unknown keys are rejected. The legacy array format (`[{ id, value }]`) is not supported.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "ticket": {}
  }
}

Create new event

Create new event.

Inputs

User IDemployee_idtextRequired
The user's unique ID
Event nameevent_nametextRequired
The name of the event
Payloadpayloadobject
Payload.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {
      "botId": "example",
      "createdAt": "example",
      "event": "example",
      "id": "example",
      "payload": {
        "firstName": "example"
      },
      "source": "example",
      "userId": "example"
    },
    "message": "example"
  }
}

Delete user

Delete user.

Inputs

User IDemployee_idtextRequired
The unique ID of the user that needs to be deleted

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "contactDetails": {}
  }
}

Get user details

Get user details.

Inputs

User IDemployee_idtextRequired
The unique identifier for the user.
All propertiesall_propertiestext
Pass `true` to fetch all user properties; else, set `false`.One of: true, false.
Propertiespropertiestext
Use to fetch specific system or custom user properties. A comma-separated list of user properties to fetch. Leave empty to fetch all properties.
User idinclude_user_idtext
Whether to include the `userId` field in the response. Defaults to `yes`.One of: yes, no.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": {},
    "message": "example"
  }
}

Get user events

Get user events.

Inputs

User IDemployee_idtextRequired
The unique ID of the user generated internally. This is usually in the format `{botId_userId}`
Event nameevent_nametext
The name of the event. Use this parameter to filter results by event name.
Offset timestampoffset_timestampdate and time
The offset timestamp (ISO format) from which to start retrieving events. Use this parameter to paginate through event results.
Limitlimitnumber
The maximum number of events to retrieve per request. Use this parameter for result pagination and limiting the response size.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "message": "example"
  }
}

List custom views

List custom views.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "count": 1,
    "views": []
  }
}

List outbound templates

List the bot’s outbound message templates.

Inputs

None.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "templates": []
  }
}

List ticket messages

List ticket messages. Returns one page; use its continuation fields to request the next page.

Inputs

Ticket IDidtextRequired
The ticket ID.
Sort ordersort_ordertext
`asc` (oldest first within the page, default) or `desc` (newest first within the page).One of: asc, desc. Default: asc.
Pagepagenumber
Zero-based page number (100 messages per page, newest page first).Default: 0.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "count": 1,
    "messages": [],
    "next_page": 1,
    "previous_page": 1,
    "total": 1
  }
}

List tickets in a view

List tickets in a view. Returns one page; use its continuation fields to request the next page.

Inputs

Viewview_idtextRequired
The custom view ID.
Pagepagenumber
Zero-based page number (100 tickets per page).Default: 0.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "count": 1,
    "next_page": 1,
    "previous_page": 1,
    "tickets": [],
    "total": 1
  }
}

Mark a ticket missed

Mark a ticket missed.

Inputs

Ticket IDidtextRequired
The ticket ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "ticket": {}
  }
}

Remove ticket tags

Remove ticket tags.

Inputs

Ticket IDidtextRequired
The ticket ID.
TagstagslistRequired
Tags.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "tags": []
  }
}

Replace ticket tags

Replace ticket tags.

Inputs

Ticket IDidtextRequired
The ticket ID.
TagstagslistRequired
Tags.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "tags": []
  }
}

Retrieve a ticket

Retrieve a ticket.

Inputs

Ticket IDidtextRequired
The ticket ID.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "ticket": {}
  }
}

Search tickets

Search tickets. Returns one page; use its continuation fields to request the next page.

Inputs

Queryquerytext
Search query, e.g. `type:ticket status<solved` or `status:open`.
Pagepagenumber
Zero-based page number (100 tickets per page).Default: 0.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "count": 1,
    "next_page": 1,
    "previous_page": 1,
    "tickets": [],
    "total": 1
  }
}

Update a ticket

Update a ticket.

Inputs

Ticket IDidtextRequired
The ticket ID.
Statusstatustext
`solved` or `closed` resolves; `open` reopens. Other values (e.g. `pending`) return 422.One of: solved, closed, open.
Commentcommentobject
Comment.
Categorycategorytext
Group/category code. Alias `group_id`.
Assigned toassigned_totext
Agent to reassign to. Alias `assignee_id`.
Custom fieldscustom_fieldsobject
Key-value custom fields; unknown keys are rejected.
Tagstagslist
Tags.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "previousTicketId": "example",
    "ticket": {}
  }
}

Update user

Update user.

Inputs

User IDemployee_idtextRequired
The unique ID of the user.
First namefirst_nametext
The first name of the user
Last namelast_nametext
The last name of the user
Phonephonetext
The phone number of the user
Tagstagslist
An array of tags
Countrycountrytext
The country of the user
Email opt inemail_opt_intrue/false
Indicates whether the user has opted in for email notifications

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

On this page