Display Details
Display detailed information about a post.
GET URL: http:/{endpoint}/post/{Id} |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/?Token={Api Token}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Approve Post
If the post is in moderation, approve the post into the event. If the post is On Deck, approve the post into the event.
GET URL: http:/{endpoint}/post/{Id}/approve |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/approve/?Token={Api Token}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Delete Post
Delete the post.
GET URL: http:/{endpoint}/post/{Id}/delete |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/delete/?Token={Api Token}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Post on Deck
Moves the post from a moderated state into the On Deck state.
GET URL: http:/{endpoint}/post/{Id}/ondeck |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/ondeck/?Token={Api Token}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Stick/Pin Post
Stick the post in its event.
GET URL: http:/{endpoint}/post/{Id}/stick |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/stick/?Token={Api Token}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Unstick Post
Unstick the post in its event.
GET URL: http:/{endpoint}/post/{Id}/unstick |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/unstick/?Token={Api Token}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Edit Text
Edit the content of a text post.
GET URL: http:/{endpoint}/post/{Id}/edit |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/edit/?Token={Api Token}&Content={HTML Content}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the post that is being accessed or manipulated. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API. |
Content | true | string | The content to be edited in the post. |
Icons | – | integer | The content icon to associate with this post ( Setting it to 0 will remove icons from the post ). |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
Format | – | string | Format of the data returned by the API call. Can be either “xml”, “json” or “html”. |
…………………………………………………………………………………………………………………..
Send Post to Social
Send the given post to the given social accounts.
POST URL: http:/{endpoint}/post/{Id}/social |
---|
API Call: http://apiv1.scribblelive.com/post/{Id}/edit/?Token={Api Token}&Content={HTML Content}&Auth={Authentication Key}&Format=json
Path Parameters:
NAME | REQUIRED | TYPE | DESCRIPTION |
Post Id | true | integer | The ID of the event whose information is being retrieved or modified. |
Token | true | string | The token is a dedicated authorization key provided to the client to consume the API. |
SendTo | true | string | A JSON encoded list of social account providers to send the post to.
*Note: Both the post and the social accounts must belong to the requesting user* |
Auth | true | string | The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials. |
…………………………………………………………………………………………………………………..