Create List Group
Call this endpoint as a POST request to create a list group with the details that you have provided in the body.
Endpoint
| Method | URL |
|---|---|
| POST | https://[Your URL]/api/2.0/list_groups |
Request Body
Properties
| Property | Description | Data type | Required |
|---|---|---|---|
| description | A description of the list group to be created | string | No |
| name | The name of the list group to be created | string | Yes |
Example Request
curl –location '[Your URL]/api/2.0/list_groups' \
–header 'Content-Type: application/json' \
–header 'Authorization: Basic ' \
–data ''
Response
| Status code | Explanation |
|---|---|
| 201 Created | The request was successfully processed |
| 401 Unauthorized | Invalid/Missing authorization credentials |
Example Responses
List group successfully created [201 Created]
Invalid/Missing authorization credentials [401 Unauthorized]
Delete List Group
Call this endpoint using a DELETE request to delete a list group with the ID you’ve provided.
Endpoint
| Method | URL | Parameters |
|---|---|---|
| DELETE | [Your URL]/api/2.0/list_groups/:id | [id] – ID of the list group to be deleted |
Request Body
Example Request
curl –location –request DELETE ‘[Your URL]/api/2.0/list_groups/15’ \
–header ‘Authorization: Basic ‘
Response
| Status code | Explanation |
|---|---|
| 204 No Content | The request was successfully processed |
| 404 Not Found | The list group with the provided ID was not found |
| 401 Unauthorized | Invalid/Missing authorization credentials |
Example Responses
Invalid/Missing authorization credentials [401 Unauthorized]
Not found [404 Not found]
Update List Group
Call this endpoint using a PUT request to update a list group.
Endpoint
| Method | URL | Parameters |
|---|---|---|
| PUT | [Your URL]/api/2.0/list_groups/:id | [id] – ID of the list group to be updated. |
Request Body
Properties
| Property | Description | Data type | Required |
|---|---|---|---|
| name | The updated name of the list group | string | Yes |
| description | An updated description of the list group | string | No |
Example Request
curl –location –request PUT [Your URL]/api/2.0/list_groups/14′ \
–header 'Content-Type: application/json' \
–header 'Authorization: Basic ' \
–data ''
Response
| Status code | Explanation |
|---|---|
| 204 No Content | The request was successfully processed |
| 404 Not Found | The list group with the provided ID was not found |
| 401 Unauthorized | Invalid/Missing authorization credentials |
Example Responses
Successfully updated list group [200 OK]
Invalid/Missing authorization credentials [401 Unauthorized]
Not found [404 Not found]
Get Single List Group
Call this endpoint as a GET request to retrieve the list group with the ID that you have provided in the URL.
Endpoint
| Method | URL | Parameters |
|---|---|---|
| GET | [Your URL]/api/2.0/list_groups/:id | [id] – ID of the requested list group |
Example Request
curl –location ‘ [Your URL]/2.0/list_groups’ \
–header ‘Authorization: Basic
Response
| Status code | Explanation |
|---|---|
| 404 Not Found | The list group with the provided ID was not found |
| 401 Unauthorized | The provided authorization credentials are incorrect |
| 200 Ok | Request was processed successfully |
Example Responses
Successful request [200 OK]
Not found [404 Not Found]
Invalid/Missing authorization credentials [401 Unauthorized]
Get List Groups
Call this endpoint as a GET request to get a list of list groups associated with your account.
Endpoint
| Method | URL |
|---|---|
| GET | [Your URL]/api/2.0/list_groups |
Example Request
–header ‘Authorization: Basic ‘
Response
| Status code | Explanation |
|---|---|
| 401 Unauthorized | The provided authorization credentials are incorrect |
| 200 Ok | List groups retrieved successfully |
Example Responses
Invalid/Missing authorization credentials [401 Unauthorized]