Yellow.ai
App · 18 actions
Manage Yellow.ai users, events, Inbox tickets and views across supported regions.
Actions
| Action | What it does |
|---|---|
| Add user | Add user. |
| Agent chat concurrency | Agent chat concurrency. |
| Create a ticket | Create a ticket. |
| Create new event | Create new event. |
| Delete user | Delete user. |
| Get user details | Get user details. |
| Get user events | Get user events. |
| List custom views | List custom views. |
| List outbound templates | List the bot’s outbound message templates. |
| List ticket messages | List ticket messages. |
| List tickets in a view | List tickets in a view. |
| Mark a ticket missed | Mark a ticket missed. |
| Remove ticket tags | Remove ticket tags. |
| Replace ticket tags | Replace ticket tags. |
| Retrieve a ticket | Retrieve a ticket. |
| Search tickets | Search tickets. |
| Update a ticket | Update a ticket. |
| Update user | Update user. |
Add user
Add user.
Inputs
- User ID
employee_idtextRequired - Unique identifier of the user.
- First name
first_nametext - The first name of the user.
- Last name
last_nametext - Last name of the user.
- Gender
gendertext - Gender of the user.
- Country
countrytext - Country of the user.
- City
citytext - City of the user according to the user's address.
- Language
languagetext - Preferred language of the user.
- Email
emailtext - Email address of the user.
- Phone
phonetext - Phone number of the user with country code.
- Last channel
last_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.
- Dob
dobdate - Date of birth of the user.
- Email optin
email_optintrue/false - Subscription status of the user to emails. Pass `true` to subscribe for emails, else pass `false`.
- Sms optin
sms_optintrue/false - Subscription status of the user to SMS. Pass `true` to subscribe the user to SMS, else pass `false`.
- Whats app optin
whats_app_optintrue/false - WhatsApp subscription status of the user. Pass `true` to subscribe the user to your WhatsApp notifications, else pass `false`.
- Tags
tagslist - 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
- Requester
requesterobjectRequired - 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.
- Source
sourcetextRequired - Channel the ticket originates from. Required.One of:
whatsapp,facebook,yellowmessenger,appleBusinessChat,email,lazada,instagram. - Subject
subjecttext - Ticket subject text. Alias `issue` is also accepted.
- Priority
prioritytext - 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. - Tags
tagslist - Tags to set on the ticket. Must be an array.
- Category
categorytext - Group/category code to assign. Alias `group_id` is also accepted.
- Assigned to
assigned_totext - Agent to assign the ticket to. Alias `assignee_id` is also accepted.
- Custom fields
custom_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 ID
employee_idtextRequired - The user's unique ID
- Event name
event_nametextRequired - The name of the event
- Payload
payloadobject - 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 ID
employee_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 ID
employee_idtextRequired - The unique identifier for the user.
- All properties
all_propertiestext - Pass `true` to fetch all user properties; else, set `false`.One of:
true,false. - Properties
propertiestext - 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 id
include_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 ID
employee_idtextRequired - The unique ID of the user generated internally. This is usually in the format `{botId_userId}`
- Event name
event_nametext - The name of the event. Use this parameter to filter results by event name.
- Offset timestamp
offset_timestampdate and time - The offset timestamp (ISO format) from which to start retrieving events. Use this parameter to paginate through event results.
- Limit
limitnumber - 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 ID
idtextRequired - The ticket ID.
- Sort order
sort_ordertext - `asc` (oldest first within the page, default) or `desc` (newest first within the page).One of:
asc,desc. Default:asc. - Page
pagenumber - 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
- View
view_idtextRequired - The custom view ID.
- Page
pagenumber - 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 ID
idtextRequired - The ticket ID.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"ticket": {}
}
}Remove ticket tags
Remove ticket tags.
Inputs
- Ticket ID
idtextRequired - The ticket ID.
- Tags
tagslistRequired - Tags.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"tags": []
}
}Replace ticket tags
Replace ticket tags.
Inputs
- Ticket ID
idtextRequired - The ticket ID.
- Tags
tagslistRequired - Tags.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"tags": []
}
}Retrieve a ticket
Retrieve a ticket.
Inputs
- Ticket ID
idtextRequired - 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
- Query
querytext - Search query, e.g. `type:ticket status<solved` or `status:open`.
- Page
pagenumber - 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 ID
idtextRequired - The ticket ID.
- Status
statustext - `solved` or `closed` resolves; `open` reopens. Other values (e.g. `pending`) return 422.One of:
solved,closed,open. - Comment
commentobject - Comment.
- Category
categorytext - Group/category code. Alias `group_id`.
- Assigned to
assigned_totext - Agent to reassign to. Alias `assignee_id`.
- Custom fields
custom_fieldsobject - Key-value custom fields; unknown keys are rejected.
- Tags
tagslist - Tags.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"previousTicketId": "example",
"ticket": {}
}
}Update user
Update user.
Inputs
- User ID
employee_idtextRequired - The unique ID of the user.
- First name
first_nametext - The first name of the user
- Last name
last_nametext - The last name of the user
- Phone
phonetext - The phone number of the user
- Tags
tagslist - An array of tags
- Country
countrytext - The country of the user
- Email opt in
email_opt_intrue/false - Indicates whether the user has opted in for email notifications
Outputs
dataobject- Response.
Example output
{
"data": {}
}