1. API
  2. v1
  3. CHANNELS
  4. TWITTER

Accounts

Resource Fields

Name Type Read-only Description
uuid string
screen_name string The Twitter Handle
profile_image_url string
brand Brand
route_mentions boolean Enable the routing for the twitter mentions timeline

Default: true
route_messages boolean Enable the routing for the twitter direct messages

Default: true
route_favorites boolean Enable the routing for the twitter home timeline

Default: true
show_in_help_center boolean Display latest tweets on home page

Default: true
status string AVAILABLE, UNAVAILABLE, NOT_AUTHORIZED

Default: AVAILABLE
is_enabled boolean Default: true
last_synced_at timestamp ISO-8601 Format
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all accounts

GET /api/v1/twitter/accounts.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Ordered by id (descending)

Response

    {
        "status": 200,
        "data": [
            {
    "id": "3155953718",

    "uuid": "cc9e8868-3023-4df9-bd90-d8f1135c1f21",
    "screen_name": "brewfictus",
    "profile_image_url": "http://abs.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "route_mentions": true,
    "route_messages": true,
    "route_favorites": true,
    "show_in_help_center": true,
    "status": "AVAILABLE",
    "is_enabled": true,
    "last_synced_at": "2015-07-29T01:14:19+05:00",
    "created_at": "2015-07-29T01:14:19+05:00",
    "updated_at": "2015-07-29T01:14:19+05:00",

    "resource_type": "twitter_account"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/twitter/accounts/3155953718"

}
        ],
        "resource": "twitter_account",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve an account

GET /api/v1/twitter/accounts/:id.json

Information

Allowed for Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": "3155953718",

    "uuid": "cc9e8868-3023-4df9-bd90-d8f1135c1f21",
    "screen_name": "brewfictus",
    "profile_image_url": "http://abs.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "route_mentions": true,
    "route_messages": true,
    "route_favorites": true,
    "show_in_help_center": true,
    "status": "AVAILABLE",
    "is_enabled": true,
    "last_synced_at": "2015-07-29T01:14:19+05:00",
    "created_at": "2015-07-29T01:14:19+05:00",
    "updated_at": "2015-07-29T01:14:19+05:00",

    "resource_type": "twitter_account"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/twitter/accounts/3155953718"

},
        "resource": "twitter_account"
    }

Update an account

PUT /api/v1/twitter/accounts/:id.json

Information

Allowed for Admins & Owners

Parameters

Name Type Mandatory Description
brand_id integer
route_mentions boolean
route_messages boolean
route_favorites boolean
show_in_help_center boolean
is_enabled boolean

Response

    {
        "status": 200,
        "data":{
    "id": "3155953718",

    "uuid": "cc9e8868-3023-4df9-bd90-d8f1135c1f21",
    "screen_name": "brewfictus",
    "profile_image_url": "http://abs.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "route_mentions": true,
    "route_messages": true,
    "route_favorites": true,
    "show_in_help_center": true,
    "status": "AVAILABLE",
    "is_enabled": true,
    "last_synced_at": "2015-07-29T01:14:19+05:00",
    "created_at": "2015-07-29T01:14:19+05:00",
    "updated_at": "2015-07-29T01:14:19+05:00",

    "resource_type": "twitter_account"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/twitter/accounts/3155953718"

},
        "resource": "twitter_account"
    }

Update accounts

PUT /api/v1/twitter/accounts.json

Information

Allowed for Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Parameters

Name Type Mandatory Description
brand_id integer
route_mentions boolean
route_messages boolean
route_favorites boolean
show_in_help_center boolean
is_enabled boolean

Response

{
    "status": 200,
    "total_count": 2
}

Delete an account

DELETE /api/v1/twitter/accounts/:id.json

Information

Allowed for Admins & Owners

Response

{
    "status": 200
}

Delete accounts

DELETE /api/v1/twitter/accounts.json

Information

Allowed for Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}