Add

Add a new CoEmailList.

Request Format

Method

POST

URL

/co_email_lists.<format>

Request Body

CoEmailList Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoGroup

CoEmailList added

400 Bad Request

 

CoEmailList Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 

Authentication required

403 CO Does Not Exist

 

The specified CO does not exist

403 Name In Use

 

An email list already exists with the specified name in the specified CO

500 Other Error

 

Unknown error

 

Delete

Remove a CoEmailList.

Request Format

Method

DELETE

URL

/co_email_lists/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

CoEmailList deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

403 Forbidden CoEmailList cannot be deleted

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error

Edit

Edit an existing CoEmailList.

Request Format

Method

PUT

URL

/co_email_lists/<id>.<format>

Request Body

CoEmailList Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CoEmailList updated

400 Bad Request

 

CoEmailList Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 

Authentication required

403 CO Does Not Exist

 

The specified CO does not exist

403 Name In Use

 

An email list already exists with the specified name in the specified CO

404 Identifier Unknown

 

id not found

500 Other Error

 

Unknown error

 

View (all)

Retrieve all existing CoEmailLists.

Request Format

Method

GET

URL

/co_email_lists.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoEmailList Response 

CoEmailList returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per CO)

Retrieve CoEmailLists attached to a CO.

Request Format

Method

GET

URL

/co_email_lists.<format>?coid=<id>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoEmailList Response 

CoEmailList returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

View (one)

Retrieve an existing CoEmailList.

Request Format

Method

GET

URL

/co_email_lists/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoEmailList Response

CoEmailList returned

401 Unauthorized

 

Authentication required

404 CoEmailList Unknown

 

id not found

500 Other Error

 

Unknown error

Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels