PUT groups/:group id
From Social ID Developers
Revision as of 00:30, 18 November 2022 by Gabriel.prado (Talk | contribs)
Contents |
Description
Updates a Group.
Resource URL
PUT https://api.socialidnow.com/v1/marketing/groups/:group_id
Parameters
URL Parameters
group_id | required | group identifier. |
---|
JSON Parameters
group | required | a hash in the format field:value, with the necessary fields to update the group: |
---|---|---|
name | optional | group name. |
category | optional | group category. |
description | optional | group description. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
ok (200) | The group was updated successfully. |
---|---|
bad_request (400) | Some required parameter was not informed. |
unauthorized (401) | The authentication is wrong. See Authentication. |
forbidden (403) | The account does not have access to this group. |
unprocessable_entity (422) | Validation error in the field "group". |
internal_server_error (500) | An unknown error happened. |
Examples
Request
curl -iX PUT 'https://api.socialidnow.com/v1/marketing/groups/1' \ -d '{ "group": { "name":"New Name", "category":"New Category", "description":"New Description" } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200