POST selfie/hashtags
(Difference between revisions)
(moved POST selfie/hashtags to POST selfie/hashtags PT-BR) |
|||
| Line 1: | Line 1: | ||
| − | + | == Description == | |
| + | |||
| + | Creates a new hashtag to be monitored. | ||
| + | |||
| + | == Resource URL == | ||
| + | |||
| + | POST https://api.socialidnow.com/v1/marketing/selfie/hashtags | ||
| + | |||
| + | == Parameters == | ||
| + | |||
| + | === JSON Parameters === | ||
| + | |||
| + | {| | ||
| + | ! align="left" width="180px" | hashtag | ||
| + | | width="200px" | required | ||
| + | | a hash in the format field:value, with the necessary fields to create the hashtag: | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | hashtag | ||
| + | | width="200px" | required | ||
| + | | hashtag to be monitored. | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | name | ||
| + | | width="200px" | required | ||
| + | | reference name of the hashtag. | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | picture_url | ||
| + | | width="200px" | required | ||
| + | | reference picture url of the hashtag. | ||
| + | |} | ||
| + | |||
| + | == Authentication == | ||
| + | |||
| + | This API requires Marketing Account authentication. See [[Authentication]]. | ||
| + | |||
| + | == Response == | ||
| + | |||
| + | === Response Status === | ||
| + | |||
| + | {| | ||
| + | ! align="left" width="200px" | created (201) | ||
| + | | The hashtag was created successfully. | ||
| + | |- | ||
| + | ! align="left" width="200px" | bad_request (400) | ||
| + | | Some required parameter was not informed. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unauthorized (401) | ||
| + | | The authentication is wrong. See [[Authentication]]. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unprocessable_entity (422) | ||
| + | | Validation error in the field "hashtag". The hashtag must be unique in the system and must contain only the following characters: a-z, A-Z, 0-9, -, _ | ||
| + | |- | ||
| + | ! align="left" width="200px" | internal_server_error (500) | ||
| + | | An unknown error happened. | ||
| + | |} | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | === Request === | ||
| + | |||
| + | Creates the hashtag "fashion" to be monitores by the application. | ||
| + | |||
| + | curl -iX POST 'https://api.socialidnow.com/v1/marketing/selfie/hashtags' \ | ||
| + | -d '{"hashtag":{"hashtag":"fashion", "name":"Fashion", "picture_url":"http://img2.timeinc.net/people/i/2006/stylechannel/hitormiss/061204/gisele_bundchen300.jpg"}}' \ | ||
| + | -H 'Content-type:application/json' \ | ||
| + | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
| + | |||
| + | === Response === | ||
| + | |||
| + | ==== Response Headers ==== | ||
| + | |||
| + | HTTP/1.1 201 Created | ||
| + | Status: 201 | ||
Revision as of 17:57, 3 November 2014
Contents |
Description
Creates a new hashtag to be monitored.
Resource URL
POST https://api.socialidnow.com/v1/marketing/selfie/hashtags
Parameters
JSON Parameters
| hashtag | required | a hash in the format field:value, with the necessary fields to create the hashtag: |
|---|---|---|
| hashtag | required | hashtag to be monitored. |
| name | required | reference name of the hashtag. |
| picture_url | required | reference picture url of the hashtag. |
Authentication
This API requires Marketing Account authentication. See Authentication.
Response
Response Status
| created (201) | The hashtag was created successfully. |
|---|---|
| bad_request (400) | Some required parameter was not informed. |
| unauthorized (401) | The authentication is wrong. See Authentication. |
| unprocessable_entity (422) | Validation error in the field "hashtag". The hashtag must be unique in the system and must contain only the following characters: a-z, A-Z, 0-9, -, _ |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
Creates the hashtag "fashion" to be monitores by the application.
curl -iX POST 'https://api.socialidnow.com/v1/marketing/selfie/hashtags' \ -d '{"hashtag":{"hashtag":"fashion", "name":"Fashion", "picture_url":"http://img2.timeinc.net/people/i/2006/stylechannel/hitormiss/061204/gisele_bundchen300.jpg"}}' \ -H 'Content-type:application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Status: 201
