POST groups
From Social ID Developers
(Difference between revisions)
(→Examples) |
|||
| Line 58: | Line 58: | ||
curl -iX POST 'https://api.socialidnow.com/v1/marketing/groups' \ | curl -iX POST 'https://api.socialidnow.com/v1/marketing/groups' \ | ||
| − | + | -d '{ | |
| − | + | "group": { | |
| − | + | "name":"Group A", | |
| − | + | "category":"Category X", | |
| − | + | "description":"My Group A description" | |
| − | + | } | |
| − | + | }' \ | |
| − | + | -H 'Content-type: application/json' \ | |
| − | + | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | |
=== Response === | === Response === | ||
Latest revision as of 23:13, 17 November 2022
Contents |
Description
Creates a Group.
Resource URL
POST https://api.socialidnow.com/v1/marketing/groups
Parameters
JSON Parameters
| group | required | a hash in the format field:value, with the necessary fields to create a group: |
|---|---|---|
| name | required | group name. |
| category | optional | group category. |
| description | optional | group description. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
| created (201) | The group 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 "group". |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
curl -iX POST 'https://api.socialidnow.com/v1/marketing/groups' \ -d '{ "group": { "name":"Group A", "category":"Category X", "description":"My Group A description" } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Location: 'https://api.socialidnow.com/v1/marketing/groups/1' Status: 201
