curator/units.info

Retrieves information associated with your Curator Media Unit

URL

GET /v1.0/curator/units.info

Parameters

Argument Required Default Value Example Description
unit_id Required - 12345678912345 ID of your Curator Media Unit.

Responses

{
    "ok": true,
    "unit": {
        "id": "0123456",
        "name": "Nordot Feed",
        "status": "public",
        "signature_color": "0f0f0f",
        "header_type": "background",
        "header_position": "center",
        "copyright_owner": "Nordot Feed",
        "default_post_expire_days": 0,
        "created_at": "2015-11-16T19:06:46+00:00",
        "updated_at": "2018-03-05T00:23:02+00:00",
        "header_image":{
            "url": "https://nordot-res.cloudinary.com/ch/units/0123456/header_1.png",
            "url_w": 400,
            "url_h": 60,
            "thumb_360": "https://nordot-res.cloudinary.com/t_thumb_360/ch/units/0123456/header_1.png",
            "square_300": "https://nordot-res.cloudinary.com/t_square_300/ch/units/0123456/header_1.png"
        },
        "profile_image": null,
        "publisher":{
            "id":
            "1234567",
            "name"
            "The Nordot Post",
            "created_at": "2015-11-16T19:02:38+00:00",
        },
        "language": "en-US",
        "timezone": "Asia/Tokyo",
        "promo_display": true,
        "promo_media_logo":{
            "url":
            "https://nordot-res.cloudinary.com/t_size_s/ch/units/1234567/promo_media_logo_4.png",
            "url_w": 200,
            "url_h": 200
        },
        "promo_media_name": "Nordot Media",
        "promo_media_url": "https://www.nordotmedia.jp",
        "promo_image":{
            "url":
            "https://nordot-res.cloudinary.com/t_size_l/ch/units/1234567/promo_image_5.png",
            "url_w": 800,
            "url_h": 320
        },
        "promo_title": "Nordot History",
        "promo_description": "The legend of Nordot History.",
        "promo_link_text": "Subscription",
        "promo_link_url": "https://www.amazon.co.jp/1234567-Chronicle/dp/1234567",
        "promo_twitter_url": "https://twitter.com/1234567",
        "promo_facebook_url": "https://www.facebook.com/1234567",
        "promo_instagram_url": "https://www.instagram.com/1234567/",
        "promo_youtube_url": "https://www.youtube.com/channel/1234567",
        "promo_line_url": "https://timeline.line.me/user/1234567"
    }
}

If successful, the method returns a “curator unit” object that meets the specified criteria. For more details, please refer to the “curator unit” object section.

Errors

Error Code Description
no_unit_id Value for "unit_id" is not specified.
invalid_unit_id Value passed for “unit_id" is invalid.
unit_not_found The Media Unit cannot be found.

For other error codes, please refer to the Common Errors section of this document.