{"note":"OpenAPI conversion -- returning structured metadata","name":"sendgrid-mc-singlesends","description":"Twilio SendGrid Marketing Campaigns Single Sends API","version":"1.0.0","base_url":"https://api.sendgrid.com","endpoints":11,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Twilio SendGrid Marketing Campaigns Single Sends API\n@base https://api.sendgrid.com\n@version 1.0.0\n@auth Bearer bearer\n@endpoints 11\n@toc marketing(11)\n\n@endpoint POST /v3/marketing/singlesends\n@desc Create Single Send\n@required {name: str # The name of the Single Send.}\n@optional {categories: [str] # The categories to associate with this Single Send., send_at: str(date-time) # Set this property to an ISO 8601 formatted date-time when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send**](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Additionally, the `now` keyword is a valid `send_at` value only when using the Schedule Single Send endpoint. Setting this property to `now` with this endpoint will cause an error., send_to: map{list_ids: [str(uuid)], segment_ids: [str(uuid)], all: bool}, email_config: map{subject: str, html_content: str, plain_content: str, generate_plain_content: bool, design_id: str, editor: str, suppression_group_id: int, custom_unsubscribe_url: str(uri), sender_id: int, ip_pool: str}}\n@returns(201) {id: str(uuid), name: str, status: str, categories: [str], send_at: str(date-time)?, send_to: map{list_ids: [str(uuid)], segment_ids: [str(uuid)], all: bool}, updated_at: str(date-time), created_at: str(date-time), email_config: map{subject: str, html_content: str, plain_content: str, generate_plain_content: bool, design_id: str, editor: str, suppression_group_id: int?, custom_unsubscribe_url: str(uri)?, sender_id: int?, ip_pool: str?}, warnings: [map]}\n@errors {400, 500}\n\n@endpoint GET /v3/marketing/singlesends\n@desc Get All Single Sends\n@optional {page_size: int, page_token: str}\n@returns(200) {result: [map], _metadata: map{prev: str(uri), self: str(uri), next: str(uri), count: int}}\n@errors {500}\n\n@endpoint DELETE /v3/marketing/singlesends\n@desc Bulk Delete Single Sends\n@optional {ids: [str] # Single Send IDs to delete}\n@returns(204)\n@errors {404, 500}\n\n@endpoint POST /v3/marketing/singlesends/{id}\n@desc Duplicate Single Send\n@optional {name: str # The name of the duplicate Single Send. If you choose to leave the name field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text 'Copy of ' prepended to it. The end of the new Single Send name, including 'Copy of ', will be trimmed if the name exceeds the character limit.}\n@returns(201) {id: str(uuid), name: str, status: str, categories: [str], send_at: str(date-time)?, send_to: map{list_ids: [str(uuid)], segment_ids: [str(uuid)], all: bool}, updated_at: str(date-time), created_at: str(date-time), email_config: map{subject: str, html_content: str, plain_content: str, generate_plain_content: bool, design_id: str, editor: str, suppression_group_id: int?, custom_unsubscribe_url: str(uri)?, sender_id: int?, ip_pool: str?}, warnings: [map]}\n@errors {404, 500}\n\n@endpoint PATCH /v3/marketing/singlesends/{id}\n@desc Update Single Send\n@required {name: str # The name of the Single Send.}\n@optional {categories: [str] # The categories to associate with this Single Send., send_at: str(date-time) # Set this property to an ISO 8601 formatted date-time when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the [**Schedule Single Send**](https://docs.sendgrid.com/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Additionally, the `now` keyword is a valid `send_at` value only when using the Schedule Single Send endpoint. Setting this property to `now` with this endpoint will cause an error., send_to: map{list_ids: [str(uuid)], segment_ids: [str(uuid)], all: bool}, email_config: map{subject: str, html_content: str, plain_content: str, generate_plain_content: bool, design_id: str, editor: str, suppression_group_id: int, custom_unsubscribe_url: str(uri), sender_id: int, ip_pool: str}}\n@returns(202) {id: str(uuid), name: str, status: str, categories: [str], send_at: str(date-time)?, send_to: map{list_ids: [str(uuid)], segment_ids: [str(uuid)], all: bool}, updated_at: str(date-time), created_at: str(date-time), email_config: map{subject: str, html_content: str, plain_content: str, generate_plain_content: bool, design_id: str, editor: str, suppression_group_id: int?, custom_unsubscribe_url: str(uri)?, sender_id: int?, ip_pool: str?}, warnings: [map]}\n@errors {400, 404, 500}\n\n@endpoint GET /v3/marketing/singlesends/{id}\n@desc Get Single Send by ID\n@returns(200) {id: str(uuid), name: str, status: str, categories: [str], send_at: str(date-time)?, send_to: map{list_ids: [str(uuid)], segment_ids: [str(uuid)], all: bool}, updated_at: str(date-time), created_at: str(date-time), email_config: map{subject: str, html_content: str, plain_content: str, generate_plain_content: bool, design_id: str, editor: str, suppression_group_id: int?, custom_unsubscribe_url: str(uri)?, sender_id: int?, ip_pool: str?}, warnings: [map]}\n@errors {404, 500}\n\n@endpoint DELETE /v3/marketing/singlesends/{id}\n@desc Delete Single Send by ID\n@returns(204)\n@errors {404, 500}\n\n@endpoint PUT /v3/marketing/singlesends/{id}/schedule\n@desc Schedule Single Send\n@required {send_at: str(date-time) # The ISO 8601 time at which to send the Single Send. This must be in future or the string `now`. SendGrid [Mail Send](https://docs.sendgrid.com/api-reference/mail-send/mail-send) emails can be scheduled up to 72 hours in advance. However, this scheduling constraint does not apply to emails sent via [Marketing Campaigns](https://docs.sendgrid.com/ui/sending-email/how-to-send-email-with-marketing-campaigns/).}\n@returns(201) {send_at: str(date-time), status: str}\n@errors {404, 500}\n\n@endpoint DELETE /v3/marketing/singlesends/{id}/schedule\n@desc Delete Single Send Schedule\n@returns(200) {send_at: str(date-time), status: str}\n@errors {404, 500}\n\n@endpoint GET /v3/marketing/singlesends/categories\n@desc Get All Categories\n@returns(200) {categories: [str]}\n@errors {500}\n\n@endpoint POST /v3/marketing/singlesends/search\n@desc Get Single Sends Search\n@optional {page_size: int, page_token: str, name: str # leading and trailing wildcard search on name of the Single Send, status: [str] # current status of the Single Send, categories: [str] # categories to associate with this Single Send, match any single send that has at least one of the categories}\n@returns(200) {result: [map], _metadata: map{prev: str(uri), self: str(uri), next: str(uri), count: int}}\n@errors {404}\n\n@end\n"}