├── readme.md └── resend.yaml /readme.md: -------------------------------------------------------------------------------- 1 | # Resend's OpenAPI Spec 2 | 3 | This repository contains the [OpenAPI specification](https://www.openapis.org/) for Resend's API. -------------------------------------------------------------------------------- /resend.yaml: -------------------------------------------------------------------------------- 1 | openapi: 3.0.3 2 | info: 3 | title: Resend 4 | version: 1.1.0 5 | description: 'Resend is the email platform for developers.' 6 | servers: 7 | - url: https://api.resend.com 8 | security: 9 | - bearerAuth: [] 10 | tags: 11 | - name: Emails 12 | description: Start sending emails through the Resend API. 13 | - name: Domains 14 | description: Create and manage domains through the Resend API. 15 | - name: API Keys 16 | description: Create and manage API Keys through the Resend API. 17 | - name: Audiences 18 | description: Create and manage Audiences through the Resend API. 19 | - name: Contacts 20 | description: Create and manage Contacts through the Resend API. 21 | paths: 22 | /emails: 23 | post: 24 | tags: 25 | - Emails 26 | summary: Send an email 27 | requestBody: 28 | content: 29 | application/json: 30 | schema: 31 | $ref: '#/components/schemas/SendEmailRequest' 32 | responses: 33 | '200': 34 | description: OK 35 | content: 36 | application/json: 37 | schema: 38 | $ref: '#/components/schemas/SendEmailResponse' 39 | /emails/{email_id}: 40 | get: 41 | tags: 42 | - Emails 43 | summary: Retrieve a single email 44 | parameters: 45 | - name: email_id 46 | in: path 47 | required: true 48 | schema: 49 | type: string 50 | description: The ID of the email. 51 | responses: 52 | '200': 53 | description: OK 54 | content: 55 | application/json: 56 | schema: 57 | $ref: '#/components/schemas/Email' 58 | patch: 59 | tags: 60 | - Emails 61 | summary: Update a single email 62 | parameters: 63 | - name: email_id 64 | in: path 65 | required: true 66 | schema: 67 | type: string 68 | description: The ID of the email. 69 | responses: 70 | '200': 71 | description: OK 72 | content: 73 | application/json: 74 | schema: 75 | $ref: '#/components/schemas/UpdateEmailOptions' 76 | /emails/{email_id}/cancel: 77 | post: 78 | tags: 79 | - Emails 80 | summary: Cancel the schedule of the e-mail. 81 | parameters: 82 | - name: email_id 83 | in: path 84 | required: true 85 | schema: 86 | type: string 87 | description: The ID of the email. 88 | responses: 89 | '200': 90 | description: OK 91 | content: 92 | application/json: 93 | schema: 94 | $ref: '#/components/schemas/Email' 95 | /emails/batch: 96 | post: 97 | tags: 98 | - Emails 99 | summary: Trigger up to 100 batch emails at once. 100 | requestBody: 101 | content: 102 | application/json: 103 | schema: 104 | type: array 105 | items: 106 | $ref: '#/components/schemas/SendEmailRequest' 107 | responses: 108 | '200': 109 | description: OK 110 | content: 111 | application/json: 112 | schema: 113 | $ref: '#/components/schemas/CreateBatchEmailsResponse' 114 | /domains: 115 | post: 116 | tags: 117 | - Domains 118 | summary: Create a new domain 119 | requestBody: 120 | content: 121 | application/json: 122 | schema: 123 | $ref: '#/components/schemas/CreateDomainRequest' 124 | responses: 125 | '201': 126 | description: OK 127 | content: 128 | application/json: 129 | schema: 130 | $ref: '#/components/schemas/CreateDomainResponse' 131 | get: 132 | tags: 133 | - Domains 134 | summary: Retrieve a list of domains 135 | responses: 136 | '200': 137 | description: OK 138 | content: 139 | application/json: 140 | schema: 141 | $ref: '#/components/schemas/ListDomainsResponse' 142 | /domains/{domain_id}: 143 | get: 144 | tags: 145 | - Domains 146 | summary: Retrieve a single domain 147 | parameters: 148 | - name: domain_id 149 | in: path 150 | required: true 151 | schema: 152 | type: string 153 | description: The ID of the domain. 154 | responses: 155 | '200': 156 | description: OK 157 | content: 158 | application/json: 159 | schema: 160 | $ref: '#/components/schemas/Domain' 161 | patch: 162 | tags: 163 | - Domains 164 | summary: Update an existing domain 165 | requestBody: 166 | content: 167 | application/json: 168 | schema: 169 | $ref: '#/components/schemas/UpdateDomainOptions' 170 | parameters: 171 | - name: domain_id 172 | in: path 173 | required: true 174 | schema: 175 | type: string 176 | description: The ID of the domain. 177 | responses: 178 | '200': 179 | description: OK 180 | content: 181 | application/json: 182 | schema: 183 | $ref: '#/components/schemas/UpdateDomainResponseSuccess' 184 | delete: 185 | tags: 186 | - Domains 187 | summary: Remove an existing domain 188 | parameters: 189 | - name: domain_id 190 | in: path 191 | required: true 192 | schema: 193 | type: string 194 | description: The ID of the domain. 195 | responses: 196 | '200': 197 | description: OK 198 | content: 199 | application/json: 200 | schema: 201 | $ref: '#/components/schemas/DeleteDomainResponse' 202 | /domains/{domain_id}/verify: 203 | post: 204 | tags: 205 | - Domains 206 | summary: Verify an existing domain 207 | parameters: 208 | - name: domain_id 209 | in: path 210 | required: true 211 | schema: 212 | type: string 213 | description: The ID of the domain. 214 | responses: 215 | '200': 216 | description: OK 217 | content: 218 | application/json: 219 | schema: 220 | $ref: '#/components/schemas/VerifyDomainResponse' 221 | /api-keys: 222 | post: 223 | tags: 224 | - API Keys 225 | summary: Create a new API key 226 | requestBody: 227 | content: 228 | application/json: 229 | schema: 230 | $ref: '#/components/schemas/CreateApiKeyRequest' 231 | responses: 232 | '201': 233 | description: OK 234 | content: 235 | application/json: 236 | schema: 237 | $ref: '#/components/schemas/CreateApiKeyResponse' 238 | get: 239 | tags: 240 | - API Keys 241 | summary: Retrieve a list of API keys 242 | responses: 243 | '200': 244 | description: OK 245 | content: 246 | application/json: 247 | schema: 248 | $ref: '#/components/schemas/ListApiKeysResponse' 249 | /api-keys/{api_key_id}: 250 | delete: 251 | tags: 252 | - API Keys 253 | summary: Remove an existing API key 254 | parameters: 255 | - name: api_key_id 256 | in: path 257 | required: true 258 | schema: 259 | type: string 260 | description: The API key ID. 261 | responses: 262 | '200': 263 | description: OK 264 | /audiences: 265 | post: 266 | tags: 267 | - Audiences 268 | summary: Create a list of contacts 269 | requestBody: 270 | content: 271 | application/json: 272 | schema: 273 | $ref: '#/components/schemas/CreateAudienceOptions' 274 | responses: 275 | '201': 276 | description: OK 277 | content: 278 | application/json: 279 | schema: 280 | $ref: '#/components/schemas/CreateAudienceResponseSuccess' 281 | get: 282 | tags: 283 | - Audiences 284 | summary: Retrieve a list of audiences 285 | responses: 286 | '200': 287 | description: OK 288 | content: 289 | application/json: 290 | schema: 291 | $ref: '#/components/schemas/ListAudiencesResponseSuccess' 292 | /audiences/{id}: 293 | delete: 294 | tags: 295 | - Audiences 296 | summary: Remove an existing audience 297 | parameters: 298 | - name: id 299 | in: path 300 | required: true 301 | schema: 302 | type: string 303 | description: The Audience ID. 304 | responses: 305 | '200': 306 | description: OK 307 | content: 308 | application/json: 309 | schema: 310 | $ref: '#/components/schemas/RemoveAudienceResponseSuccess' 311 | get: 312 | tags: 313 | - Audiences 314 | summary: Retrieve a single audience 315 | parameters: 316 | - name: id 317 | in: path 318 | required: true 319 | schema: 320 | type: string 321 | description: The Audience ID. 322 | responses: 323 | '200': 324 | description: OK 325 | content: 326 | application/json: 327 | schema: 328 | $ref: '#/components/schemas/GetAudienceResponseSuccess' 329 | /audiences/{audience_id}/contacts: 330 | post: 331 | tags: 332 | - Contacts 333 | summary: Create a new contact 334 | parameters: 335 | - name: audience_id 336 | in: path 337 | required: true 338 | schema: 339 | type: string 340 | description: The Audience ID. 341 | requestBody: 342 | content: 343 | application/json: 344 | schema: 345 | $ref: '#/components/schemas/CreateContactOptions' 346 | responses: 347 | '201': 348 | description: OK 349 | content: 350 | application/json: 351 | schema: 352 | $ref: '#/components/schemas/CreateContactResponseSuccess' 353 | get: 354 | tags: 355 | - Contacts 356 | summary: Retrieve a list of contacts 357 | parameters: 358 | - name: audience_id 359 | in: path 360 | required: true 361 | schema: 362 | type: string 363 | description: The Audience ID. 364 | responses: 365 | '200': 366 | description: OK 367 | content: 368 | application/json: 369 | schema: 370 | $ref: '#/components/schemas/ListContactsResponseSuccess' 371 | /audiences/{audience_id}/contacts/{email}: 372 | delete: 373 | tags: 374 | - Contacts 375 | summary: Remove an existing contact by email 376 | parameters: 377 | - name: email 378 | in: path 379 | required: true 380 | schema: 381 | type: string 382 | description: The Contact ID. 383 | - name: audience_id 384 | in: path 385 | required: true 386 | schema: 387 | type: string 388 | description: The Audience ID. 389 | responses: 390 | '200': 391 | description: OK 392 | content: 393 | application/json: 394 | schema: 395 | $ref: '#/components/schemas/RemoveContactResponseSuccess' 396 | /audiences/{audience_id}/contacts/{id}: 397 | delete: 398 | tags: 399 | - Contacts 400 | summary: Remove an existing contact by id 401 | parameters: 402 | - name: id 403 | in: path 404 | required: true 405 | schema: 406 | type: string 407 | description: The Contact ID. 408 | - name: audience_id 409 | in: path 410 | required: true 411 | schema: 412 | type: string 413 | description: The Audience ID. 414 | responses: 415 | '200': 416 | description: OK 417 | content: 418 | application/json: 419 | schema: 420 | $ref: '#/components/schemas/RemoveContactResponseSuccess' 421 | get: 422 | tags: 423 | - Contacts 424 | summary: Retrieve a single contact 425 | parameters: 426 | - name: id 427 | in: path 428 | required: true 429 | schema: 430 | type: string 431 | description: The Contact ID. 432 | - name: audience_id 433 | in: path 434 | required: true 435 | schema: 436 | type: string 437 | description: The Audience ID. 438 | responses: 439 | '200': 440 | description: OK 441 | content: 442 | application/json: 443 | schema: 444 | $ref: '#/components/schemas/GetContactResponseSuccess' 445 | patch: 446 | tags: 447 | - Contacts 448 | summary: Update a single contact 449 | parameters: 450 | - name: id 451 | in: path 452 | required: true 453 | schema: 454 | type: string 455 | description: The Contact ID. 456 | - name: audience_id 457 | in: path 458 | required: true 459 | schema: 460 | type: string 461 | description: The Audience ID. 462 | requestBody: 463 | content: 464 | application/json: 465 | schema: 466 | $ref: '#/components/schemas/UpdateContactOptions' 467 | responses: 468 | '200': 469 | description: OK 470 | content: 471 | application/json: 472 | schema: 473 | $ref: '#/components/schemas/UpdateContactResponseSuccess' 474 | /broadcasts: 475 | post: 476 | tags: 477 | - Broadcasts 478 | summary: Create a broadcast 479 | requestBody: 480 | content: 481 | application/json: 482 | schema: 483 | $ref: '#/components/schemas/CreateBroadcastOptions' 484 | responses: 485 | '201': 486 | description: OK 487 | content: 488 | application/json: 489 | schema: 490 | $ref: '#/components/schemas/CreateBroadcastResponseSuccess' 491 | get: 492 | tags: 493 | - Broadcasts 494 | summary: Retrieve a list of broadcasts 495 | responses: 496 | '200': 497 | description: OK 498 | content: 499 | application/json: 500 | schema: 501 | $ref: '#/components/schemas/ListBroadcastsResponseSuccess' 502 | /broadcasts/{id}: 503 | delete: 504 | tags: 505 | - Broadcasts 506 | summary: Remove an existing broadcast that is in the draft status 507 | parameters: 508 | - name: id 509 | in: path 510 | required: true 511 | schema: 512 | type: string 513 | description: The Broadcast ID. 514 | responses: 515 | '200': 516 | description: OK 517 | content: 518 | application/json: 519 | schema: 520 | $ref: '#/components/schemas/RemoveBroadcastResponseSuccess' 521 | get: 522 | tags: 523 | - Broadcasts 524 | summary: Retrieve a single broadcast 525 | parameters: 526 | - name: id 527 | in: path 528 | required: true 529 | schema: 530 | type: string 531 | description: The Broadcast ID. 532 | responses: 533 | '200': 534 | description: OK 535 | content: 536 | application/json: 537 | schema: 538 | $ref: '#/components/schemas/GetBroadcastResponseSuccess' 539 | /broadcasts/{id}/send: 540 | post: 541 | tags: 542 | - Broadcasts 543 | summary: Send or schedule a broadcast 544 | parameters: 545 | - name: id 546 | in: path 547 | required: true 548 | schema: 549 | type: string 550 | description: The Broadcast ID. 551 | requestBody: 552 | content: 553 | application/json: 554 | schema: 555 | $ref: '#/components/schemas/SendBroadcastOptions' 556 | responses: 557 | '200': 558 | description: OK 559 | content: 560 | application/json: 561 | schema: 562 | $ref: '#/components/schemas/SendBroadcastResponseSuccess' 563 | components: 564 | securitySchemes: 565 | bearerAuth: 566 | type: http 567 | scheme: bearer 568 | schemas: 569 | SendEmailRequest: 570 | type: object 571 | required: 572 | - from 573 | - to 574 | - subject 575 | properties: 576 | from: 577 | type: string 578 | description: Sender email address. To include a friendly name, use the format "Your Name ". 579 | to: 580 | type: array 581 | items: 582 | type: string 583 | description: Recipient email address. For multiple addresses, send as an array of strings. Max 50. 584 | subject: 585 | type: string 586 | description: Email subject. 587 | bcc: 588 | type: string 589 | description: Bcc recipient email address. For multiple addresses, send as an array of strings. 590 | cc: 591 | type: string 592 | description: Cc recipient email address. For multiple addresses, send as an array of strings. 593 | reply_to: 594 | type: string 595 | description: Reply-to email address. For multiple addresses, send as an array of strings. 596 | html: 597 | type: string 598 | description: The HTML version of the message. 599 | text: 600 | type: string 601 | description: The plain text version of the message. 602 | headers: 603 | type: object 604 | description: Custom headers to add to the email. 605 | scheduled_at: 606 | type: string 607 | description: Schedule email to be sent later. The date should be in ISO 8601 format. 608 | attachments: 609 | type: array 610 | items: 611 | $ref: '#/components/schemas/Attachment' 612 | tags: 613 | type: array 614 | items: 615 | $ref: '#/components/schemas/Tag' 616 | Attachment: 617 | type: object 618 | properties: 619 | content: 620 | type: string 621 | format: binary 622 | description: Content of an attached file. 623 | filename: 624 | type: string 625 | description: Name of attached file. 626 | path: 627 | type: string 628 | description: Path where the attachment file is hosted 629 | content_type: 630 | type: string 631 | description: Optional content type for the attachment, if not set it will be derived from the filename property 632 | Tag: 633 | type: object 634 | properties: 635 | name: 636 | type: string 637 | description: The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters. 638 | value: 639 | type: string 640 | description: The value of the email tag.It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters. 641 | SendEmailResponse: 642 | type: object 643 | properties: 644 | id: 645 | type: string 646 | description: The ID of the sent email. 647 | UpdateEmailOptions: 648 | type: object 649 | properties: 650 | scheduled_at: 651 | type: string 652 | description: Schedule email to be sent later. The date should be in ISO 8601 format. 653 | Email: 654 | type: object 655 | properties: 656 | object: 657 | type: string 658 | description: The type of object. 659 | example: 'email' 660 | id: 661 | type: string 662 | description: The ID of the email. 663 | example: '4ef9a417-02e9-4d39-ad75-9611e0fcc33c' 664 | to: 665 | type: array 666 | items: 667 | type: string 668 | description: The email addresses of the recipients. 669 | example: ['delivered@resend.dev'] 670 | from: 671 | type: string 672 | description: The email address of the sender. 673 | example: 'Acme ' 674 | created_at: 675 | type: string 676 | format: date-time 677 | description: The date and time the email was created. 678 | example: '2023-04-03T22:13:42.674981+00:00' 679 | subject: 680 | type: string 681 | description: The subject line of the email. 682 | example: 'Hello World' 683 | html: 684 | type: string 685 | description: The HTML body of the email. 686 | example: 'Congrats on sending your first email!' 687 | text: 688 | type: string 689 | description: The plain text body of the email. 690 | bcc: 691 | type: array 692 | items: 693 | type: string 694 | description: The email addresses of the blind carbon copy recipients. 695 | cc: 696 | type: array 697 | items: 698 | type: string 699 | description: The email addresses of the carbon copy recipients. 700 | reply_to: 701 | type: array 702 | items: 703 | type: string 704 | description: The email addresses to which replies should be sent. 705 | last_event: 706 | type: string 707 | description: The status of the email. 708 | example: 'delivered' 709 | CreateBatchEmailsResponse: 710 | type: object 711 | properties: 712 | data: 713 | type: array 714 | items: 715 | type: object 716 | properties: 717 | id: 718 | type: string 719 | description: The ID of the sent email. 720 | CreateDomainRequest: 721 | type: object 722 | required: 723 | - name 724 | properties: 725 | name: 726 | type: string 727 | description: The name of the domain you want to create. 728 | region: 729 | type: string 730 | enum: 731 | - us-east-1 732 | - eu-west-1 733 | - sa-east-1 734 | default: us-east-1 735 | description: The region where emails will be sent from. Possible values are us-east-1' | 'eu-west-1' | 'sa-east-1 736 | CreateDomainResponse: 737 | type: object 738 | properties: 739 | id: 740 | type: string 741 | description: The ID of the domain. 742 | name: 743 | type: string 744 | description: The name of the domain. 745 | created_at: 746 | type: string 747 | format: date-time 748 | description: The date and time the domain was created. 749 | status: 750 | type: string 751 | description: The status of the domain. 752 | records: 753 | type: array 754 | items: 755 | $ref: '#/components/schemas/DomainRecord' 756 | region: 757 | type: string 758 | description: The region where the domain is hosted. 759 | UpdateDomainOptions: 760 | type: object 761 | properties: 762 | open_tracking: 763 | type: boolean 764 | description: Track the open rate of each email. 765 | click_tracking: 766 | type: boolean 767 | description: Track clicks within the body of each HTML email. 768 | tls: 769 | type: string 770 | description: enforced | opportunistic. 771 | default: "opportunistic" 772 | DomainRecord: 773 | type: object 774 | properties: 775 | record: 776 | type: string 777 | description: The type of record. 778 | name: 779 | type: string 780 | description: The name of the record. 781 | type: 782 | type: string 783 | description: The type of record. 784 | ttl: 785 | type: string 786 | description: The time to live for the record. 787 | status: 788 | type: string 789 | description: The status of the record. 790 | value: 791 | type: string 792 | description: The value of the record. 793 | priority: 794 | type: integer 795 | description: The priority of the record. 796 | Domain: 797 | type: object 798 | properties: 799 | object: 800 | type: string 801 | description: The type of object. 802 | example: 'domain' 803 | id: 804 | type: string 805 | description: The ID of the domain. 806 | example: 'd91cd9bd-1176-453e-8fc1-35364d380206' 807 | name: 808 | type: string 809 | description: The name of the domain. 810 | example: 'example.com' 811 | status: 812 | type: string 813 | description: The status of the domain. 814 | example: 'not_started' 815 | created_at: 816 | type: string 817 | format: date-time 818 | description: The date and time the domain was created. 819 | example: '2023-04-26T20:21:26.347412+00:00' 820 | region: 821 | type: string 822 | description: The region where the domain is hosted. 823 | example: 'us-east-1' 824 | records: 825 | type: array 826 | items: 827 | $ref: '#/components/schemas/DomainRecord' 828 | VerifyDomainResponse: 829 | type: object 830 | properties: 831 | object: 832 | type: string 833 | description: The type of object. 834 | example: 'domain' 835 | id: 836 | type: string 837 | description: The ID of the domain. 838 | example: 'd91cd9bd-1176-453e-8fc1-35364d380206' 839 | ListDomainsResponse: 840 | type: object 841 | properties: 842 | data: 843 | type: array 844 | items: 845 | $ref: '#/components/schemas/ListDomainsItem' 846 | ListDomainsItem: 847 | type: object 848 | properties: 849 | id: 850 | type: string 851 | description: The ID of the domain. 852 | example: 'd91cd9bd-1176-453e-8fc1-35364d380206' 853 | name: 854 | type: string 855 | description: The name of the domain. 856 | example: 'example.com' 857 | status: 858 | type: string 859 | description: The status of the domain. 860 | example: 'not_started' 861 | created_at: 862 | type: string 863 | format: date-time 864 | description: The date and time the domain was created. 865 | example: '2023-04-26T20:21:26.347412+00:00' 866 | region: 867 | type: string 868 | description: The region where the domain is hosted. 869 | example: 'us-east-1' 870 | UpdateDomainResponseSuccess: 871 | type: object 872 | properties: 873 | id: 874 | type: string 875 | description: The ID of the updated domain. 876 | example: 'd91cd9bd-1176-453e-8fc1-35364d380206' 877 | object: 878 | type: string 879 | description: The object type representing the updated domain. 880 | example: 'domain' 881 | DeleteDomainResponse: 882 | type: object 883 | properties: 884 | object: 885 | type: string 886 | description: The type of object. 887 | example: 'domain' 888 | id: 889 | type: string 890 | description: The ID of the domain. 891 | example: 'd91cd9bd-1176-453e-8fc1-35364d380206' 892 | deleted: 893 | type: boolean 894 | description: Indicates whether the domain was deleted successfully. 895 | example: true 896 | CreateApiKeyRequest: 897 | type: object 898 | required: 899 | - name 900 | properties: 901 | name: 902 | type: string 903 | description: The API key name. 904 | permission: 905 | type: string 906 | enum: 907 | - full_access 908 | - sending_access 909 | description: The API key can have full access to Resend’s API or be only restricted to send emails. * full_access - Can create, delete, get, and update any resource. * sending_access - Can only send emails. 910 | domain_id: 911 | type: string 912 | description: Restrict an API key to send emails only from a specific domain. Only used when the permission is sending_acces. 913 | CreateApiKeyResponse: 914 | type: object 915 | properties: 916 | id: 917 | type: string 918 | description: The ID of the API key. 919 | token: 920 | type: string 921 | description: The token of the API key. 922 | ListApiKeysResponse: 923 | type: object 924 | properties: 925 | data: 926 | type: array 927 | items: 928 | $ref: '#/components/schemas/ApiKey' 929 | ApiKey: 930 | type: object 931 | properties: 932 | id: 933 | type: string 934 | description: The ID of the API key. 935 | name: 936 | type: string 937 | description: The name of the API key. 938 | created_at: 939 | type: string 940 | format: date-time 941 | description: The date and time the API key was created. 942 | CreateAudienceOptions: 943 | type: object 944 | required: 945 | - name 946 | properties: 947 | name: 948 | type: string 949 | description: The name of the audience you want to create. 950 | CreateAudienceResponseSuccess: 951 | type: object 952 | properties: 953 | id: 954 | type: string 955 | description: The ID of the audience. 956 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 957 | object: 958 | type: string 959 | description: The object of the audience. 960 | example: audience 961 | name: 962 | type: string 963 | description: The name of the audience. 964 | example: Registered Users 965 | GetAudienceResponseSuccess: 966 | type: object 967 | properties: 968 | id: 969 | type: string 970 | description: The ID of the audience. 971 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 972 | object: 973 | type: string 974 | description: The object of the audience. 975 | example: audience 976 | name: 977 | type: string 978 | description: The name of the audience. 979 | example: Registered Users 980 | created_at: 981 | type: string 982 | description: The date that the object was created. 983 | example: 2023-10-06T22:59:55.977Z 984 | RemoveAudienceResponseSuccess: 985 | type: object 986 | properties: 987 | id: 988 | type: string 989 | description: The ID of the audience. 990 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 991 | object: 992 | type: string 993 | description: The object of the audience. 994 | example: audience 995 | deleted: 996 | type: boolean 997 | description: The deleted attribute indicates that the corresponding audience has been deleted. 998 | example: true 999 | ListAudiencesResponseSuccess: 1000 | type: object 1001 | properties: 1002 | object: 1003 | type: string 1004 | description: Type of the response object. 1005 | example: list 1006 | data: 1007 | type: array 1008 | description: Array containing audience information. 1009 | items: 1010 | type: object 1011 | properties: 1012 | id: 1013 | type: string 1014 | description: Unique identifier for the audience. 1015 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 1016 | name: 1017 | type: string 1018 | description: Name of the audience. 1019 | example: Registered Users 1020 | created_at: 1021 | type: string 1022 | format: date-time 1023 | description: Timestamp indicating when the audience was created. 1024 | example: "2023-10-06T22:59:55.977Z" 1025 | CreateContactOptions: 1026 | type: object 1027 | required: 1028 | - email 1029 | properties: 1030 | email: 1031 | type: string 1032 | description: Email address of the contact. 1033 | example: steve.wozniak@gmail.com 1034 | first_name: 1035 | type: string 1036 | description: First name of the contact. 1037 | example: Steve 1038 | last_name: 1039 | type: string 1040 | description: Last name of the contact. 1041 | example: Wozniak 1042 | unsubscribed: 1043 | type: boolean 1044 | description: Indicates if the contact is unsubscribed. 1045 | example: false 1046 | audience_id: 1047 | type: string 1048 | description: Unique identifier of the audience to which the contact belongs. 1049 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 1050 | CreateContactResponseSuccess: 1051 | type: object 1052 | properties: 1053 | object: 1054 | type: string 1055 | description: Type of the response object. 1056 | example: contact 1057 | id: 1058 | type: string 1059 | description: Unique identifier for the created contact. 1060 | example: 479e3145-dd38-476b-932c-529ceb705947 1061 | GetContactResponseSuccess: 1062 | type: object 1063 | properties: 1064 | object: 1065 | type: string 1066 | description: Type of the response object. 1067 | example: contact 1068 | id: 1069 | type: string 1070 | description: Unique identifier for the contact. 1071 | example: e169aa45-1ecf-4183-9955-b1499d5701d3 1072 | email: 1073 | type: string 1074 | description: Email address of the contact. 1075 | example: steve.wozniak@gmail.com 1076 | first_name: 1077 | type: string 1078 | description: First name of the contact. 1079 | example: Steve 1080 | last_name: 1081 | type: string 1082 | description: Last name of the contact. 1083 | example: Wozniak 1084 | created_at: 1085 | type: string 1086 | format: date-time 1087 | description: Timestamp indicating when the contact was created. 1088 | example: "2023-10-06T23:47:56.678Z" 1089 | unsubscribed: 1090 | type: boolean 1091 | description: Indicates if the contact is unsubscribed. 1092 | example: false 1093 | UpdateContactOptions: 1094 | type: object 1095 | properties: 1096 | email: 1097 | type: string 1098 | description: Email address of the contact. 1099 | example: steve.wozniak@gmail.com 1100 | first_name: 1101 | type: string 1102 | description: First name of the contact. 1103 | example: Steve 1104 | last_name: 1105 | type: string 1106 | description: Last name of the contact. 1107 | example: Wozniak 1108 | unsubscribed: 1109 | type: boolean 1110 | description: Indicates the subscription status of the contact. 1111 | example: false 1112 | UpdateContactResponseSuccess: 1113 | type: object 1114 | properties: 1115 | object: 1116 | type: string 1117 | description: Type of the response object. 1118 | example: contact 1119 | id: 1120 | type: string 1121 | description: Unique identifier for the updated contact. 1122 | example: 479e3145-dd38-476b-932c-529ceb705947 1123 | RemoveContactResponseSuccess: 1124 | type: object 1125 | properties: 1126 | object: 1127 | type: string 1128 | description: Type of the response object. 1129 | example: contact 1130 | id: 1131 | type: string 1132 | description: Unique identifier for the removed contact. 1133 | example: 520784e2-887d-4c25-b53c-4ad46ad38100 1134 | deleted: 1135 | type: boolean 1136 | description: Indicates whether the contact was successfully deleted. 1137 | example: true 1138 | ListContactsResponseSuccess: 1139 | type: object 1140 | properties: 1141 | object: 1142 | type: string 1143 | description: Type of the response object. 1144 | example: list 1145 | data: 1146 | type: array 1147 | description: Array containing contact information. 1148 | items: 1149 | type: object 1150 | properties: 1151 | id: 1152 | type: string 1153 | description: Unique identifier for the contact. 1154 | example: e169aa45-1ecf-4183-9955-b1499d5701d3 1155 | email: 1156 | type: string 1157 | description: Email address of the contact. 1158 | example: steve.wozniak@gmail.com 1159 | first_name: 1160 | type: string 1161 | description: First name of the contact. 1162 | example: Steve 1163 | last_name: 1164 | type: string 1165 | description: Last name of the contact. 1166 | example: Wozniak 1167 | created_at: 1168 | type: string 1169 | format: date-time 1170 | description: Timestamp indicating when the contact was created. 1171 | example: "2023-10-06T23:47:56.678Z" 1172 | unsubscribed: 1173 | type: boolean 1174 | description: Indicates if the contact is unsubscribed. 1175 | example: false 1176 | CreateBroadcastOptions: 1177 | type: object 1178 | required: 1179 | - audience_id 1180 | - from 1181 | - subject 1182 | properties: 1183 | name: 1184 | type: string 1185 | description: Name of the broadcast. 1186 | audience_id: 1187 | type: string 1188 | description: Unique identifier of the audience this broadcast will be sent to. 1189 | from: 1190 | type: string 1191 | description: The email address of the sender. 1192 | subject: 1193 | type: string 1194 | description: The subject line of the email. 1195 | reply_to: 1196 | type: array 1197 | items: 1198 | type: string 1199 | description: The email addresses to which replies should be sent. 1200 | preview_text: 1201 | type: string 1202 | description: The preview text of the email. 1203 | example: 'Here are our announcements' 1204 | html: 1205 | type: string 1206 | description: The HTML version of the message. 1207 | text: 1208 | type: string 1209 | description: The plain text version of the message. 1210 | CreateBroadcastResponseSuccess: 1211 | type: object 1212 | properties: 1213 | id: 1214 | type: string 1215 | description: The ID of the broadcast. 1216 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 1217 | object: 1218 | type: string 1219 | description: The object type of the response. 1220 | example: broadcast 1221 | ListBroadcastsResponseSuccess: 1222 | type: object 1223 | properties: 1224 | object: 1225 | type: string 1226 | description: Type of the response object. 1227 | example: list 1228 | data: 1229 | type: array 1230 | description: Array containing broadcast information. 1231 | items: 1232 | type: object 1233 | properties: 1234 | id: 1235 | type: string 1236 | description: Unique identifier for the broadcast. 1237 | example: e169aa45-1ecf-4183-9955-b1499d5701d3 1238 | name: 1239 | type: string 1240 | description: Name of the broadcast. 1241 | example: November announcements 1242 | audience_id: 1243 | type: string 1244 | description: Unique identifier of the audience this broadcast will be sent to. 1245 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 1246 | status: 1247 | type: string 1248 | description: The status of the broadcast. 1249 | example: 'draft' 1250 | created_at: 1251 | type: string 1252 | format: date-time 1253 | description: Timestamp indicating when the broadcast was created. 1254 | example: "2023-10-06T22:59:55.977Z" 1255 | scheduled_at: 1256 | type: string 1257 | format: date-time 1258 | description: Timestamp indicating when the broadcast is scheduled to be sent. 1259 | example: "2023-10-06T22:59:55.977Z" 1260 | sent_at: 1261 | type: string 1262 | format: date-time 1263 | description: Timestamp indicating when the broadcast was sent. 1264 | example: "2023-10-06T22:59:55.977Z" 1265 | GetBroadcastResponseSuccess: 1266 | type: object 1267 | properties: 1268 | id: 1269 | type: string 1270 | description: Unique identifier for the broadcast. 1271 | example: e169aa45-1ecf-4183-9955-b1499d5701d3 1272 | name: 1273 | type: string 1274 | description: Name of the broadcast. 1275 | example: November announcements 1276 | audience_id: 1277 | type: string 1278 | description: Unique identifier of the audience this broadcast will be sent to. 1279 | from: 1280 | type: string 1281 | description: The email address of the sender. 1282 | example: 'Acme ' 1283 | subject: 1284 | type: string 1285 | description: The subject line of the email. 1286 | example: 'Hello World' 1287 | reply_to: 1288 | type: array 1289 | items: 1290 | type: string 1291 | description: The email addresses to which replies should be sent. 1292 | preview_text: 1293 | type: string 1294 | description: The preview text of the email. 1295 | example: 'Here are our announcements' 1296 | status: 1297 | type: string 1298 | description: The status of the broadcast. 1299 | example: 'draft' 1300 | created_at: 1301 | type: string 1302 | format: date-time 1303 | description: Timestamp indicating when the broadcast was created. 1304 | example: "2023-10-06T22:59:55.977Z" 1305 | scheduled_at: 1306 | type: string 1307 | format: date-time 1308 | description: Timestamp indicating when the broadcast is scheduled to be sent. 1309 | example: "2023-10-06T22:59:55.977Z" 1310 | sent_at: 1311 | type: string 1312 | format: date-time 1313 | description: Timestamp indicating when the broadcast was sent. 1314 | example: "2023-10-06T22:59:55.977Z" 1315 | RemoveBroadcastResponseSuccess: 1316 | type: object 1317 | properties: 1318 | id: 1319 | type: string 1320 | description: The ID of the broadcast. 1321 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 1322 | object: 1323 | type: string 1324 | description: Type of the response object. 1325 | example: broadcast 1326 | deleted: 1327 | type: boolean 1328 | description: The deleted attribute indicates that the corresponding broadcast has been deleted. 1329 | example: true 1330 | SendBroadcastOptions: 1331 | type: object 1332 | properties: 1333 | scheduled_at: 1334 | type: string 1335 | description: Schedule email to be sent later. The date should be in ISO 8601 format. 1336 | SendBroadcastResponseSuccess: 1337 | type: object 1338 | properties: 1339 | id: 1340 | type: string 1341 | description: The ID of the broadcast. 1342 | example: 78261eea-8f8b-4381-83c6-79fa7120f1cf 1343 | --------------------------------------------------------------------------------