import{_ as u,r as p,o as r,c as d,d as a,w as t,a as n,b as s,e as c}from"./app.f28c5e71.js";const k={},m=c(`

Users

Get a list of account users

Retrieve information about account users with this GET request:

GET https://api.mailersend.com/v1/users

`,4),v=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"user"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"getAll"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),b={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},g=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("user"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"list"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),h={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},y=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("page"),n("span",{class:"token punctuation"},"("),n("span",{class:"token number"},"1"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("limit"),n("span",{class:"token punctuation"},"("),n("span",{class:"token number"},"25"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_users_list"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("list_users"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),f={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},_=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` options `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token operator"},"&"),s("mailersend"),n("span",{class:"token punctuation"},"."),s("ListUserOptions"),n("span",{class:"token punctuation"},"{"),s(` Page`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token number"},"1"),n("span",{class:"token punctuation"},","),s(` Limit`),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token number"},"25"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"List"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" options"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),q={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},w=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"User")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"UsersList")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"ListUsers"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"UsersList"),s(" list "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"users"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"getUsers"),n("span",{class:"token punctuation"},"("),n("span",{class:"token number"},"1"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"25"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"for"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"User"),s(" user "),n("span",{class:"token operator"},":"),s(" list"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),x={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},M=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_user `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_user`),n("span",{class:"token punctuation"},"."),s(`list `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),S={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},j=c(`

Responses

Valid

Response Code: 200 OK
Response Headers:
	content-type: application/json

{
  "data": [
    {
      "id": "83gwk2j7zqz1nxyd",
      "avatar": null,
      "email": "user@example.com",
      "last_name": "User",
      "name": "User",
      "2fa": false,
      "created_at": "2024-01-18T06:59:00.000000Z",
      "updated_at": "2024-01-18T07:01:26.000000Z",
      "role": "Custom User",
      "permissions": ["read-suppressions", "read-invoice", "read-own-templates"],
      "domains": [
        {
          "id": "0z76k5jg0o3yeg2d",
          "name": "example-domain.com",
          "created_at": "2024-02-20T08:13:17.000000Z",
          "updated_at": "2024-02-20T08:13:22.000000Z"
        },
        {
          "id": "9dnxr7qvdqg6pm0e",
          "name": "another-domain.com",
          "created_at": "2024-02-20T08:47:06.000000Z",
          "updated_at": "2024-02-20T08:47:11.000000Z"
        }
      ],
      "templates": [
        {
          "id": "n3k6d1jreo50x4ve",
          "name": "Template",
          "type": "gh",
          "created_at": "2024-02-23T15:40:51.000000Z"
        }
      ]
    }
  ]
}

Error

Response Code: 404 Not Found

Get a single account user

If you want to retrieve a single account user, use this GET request:

GET https://api.mailersend.com/v1/users/{user_id}

Request parameters

URL parameter	Type	Required	Limitations	Details
`user_id`	`string`	yes

`,11),P=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"user"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"find"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'userId'"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),U={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},T=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("user"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"single"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),I={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},R=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("user_id"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_user_get"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("get_user"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),C={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},E=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` userID `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token string"},'"user-id"'),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Get"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" userID"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),A={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},D=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"User")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"GetUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"User"),s(" user "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"users"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"getUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("name"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),K={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},B=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_user `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_user`),n("span",{class:"token punctuation"},"."),s("get"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"user-id"')]),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),N={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},L=c(`

Responses

Valid

Response Code: 200 OK
Response Headers:
	content-type: application/json

{
  "data": {
    "id": "83gwk2j7zqz1nxyd",
    "avatar": null,
    "email": "user@example.com",
    "last_name": "User",
    "name": "User",
    "2fa": false,
    "created_at": "2024-01-18T06:59:00.000000Z",
    "updated_at": "2024-01-18T07:01:26.000000Z",
    "role": "Custom User",
    "permissions": ["read-suppressions", "read-invoice", "read-own-templates"],
    "domains": [
      {
        "id": "0z76k5jg0o3yeg2d",
        "name": "example-domain.com",
        "created_at": "2024-02-20T08:13:17.000000Z",
        "updated_at": "2024-02-20T08:13:22.000000Z"
      },
      {
        "id": "9dnxr7qvdqg6pm0e",
        "name": "another-domain.com",
        "created_at": "2024-02-20T08:47:06.000000Z",
        "updated_at": "2024-02-20T08:47:11.000000Z"
      }
    ],
    "templates": [
      {
        "id": "n3k6d1jreo50x4ve",
        "name": "Template",
        "type": "gh",
        "created_at": "2024-02-23T15:40:51.000000Z"
      }
    ]
  }
}

Error

Response Code: 404 Not Found

Invite a user to account

If you want to add a new user to your account, use this POST request:

POST https://api.mailersend.com/v1/users

Request Parameters

JSON parameters are provided in dot notation

JSON Parameter	Type	Required	Limitations	Details
`email`	`string`	yes	`Max` 191 characters, unique
`role`	`string`	yes	Must be the name of a role	View roles
`permissions`	`string[]`	yes*	Must be list of permission names	*Only required if role is a `Custom User`. View permissions
`templates`	`string[]`	no	Must be list of template IDs
`domains`	`string[]`	no	Must be list of domain IDs
`requires_periodic_password_change`	`boolean`	no

`,12),V=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("Helpers"),n("span",{class:"token punctuation"},"\\"),s("Builder"),n("span",{class:"token punctuation"},"\\"),s("UserParams")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("Common"),n("span",{class:"token punctuation"},"\\"),s("Roles")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("Common"),n("span",{class:"token punctuation"},"\\"),s("Permissions")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token comment"},"// Basic invite with admin role"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"user"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"create"),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token punctuation"},"("),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"UserParams"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'newuser@example.com'"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token class-name static-context"},"Roles"),n("span",{class:"token operator"},"::"),n("span",{class:"token constant"},"ADMIN"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token comment"},"// Custom invite with specific permissions and access"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"user"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"create"),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token punctuation"},"("),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"UserParams"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'designer@example.com'"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token class-name static-context"},"Roles"),n("span",{class:"token operator"},"::"),n("span",{class:"token constant"},"CUSTOM_USER"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setDomains"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'domain-id'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setTemplates"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'template-id'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setPermissions"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token class-name static-context"},"Permissions"),n("span",{class:"token operator"},"::"),n("span",{class:"token constant"},"READ_OWN_TEMPLATES"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setRequiresPeriodicPasswordChange"),n("span",{class:"token punctuation"},"("),n("span",{class:"token constant boolean"},"true"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),G={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},O=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend"),n("span",{class:"token punctuation"},","),s(" User "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token comment"},"// Basic invite with admin role"),s(` `),n("span",{class:"token keyword"},"const"),s(" user "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setEmail"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"newuser@example.com"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setRole"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"admin"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("user"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"create"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token comment"},"// Custom invite with specific permissions"),s(` `),n("span",{class:"token keyword"},"const"),s(" customUser "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setEmail"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"designer@example.com"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setRole"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"designer"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-all-templates"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"manage-template"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addTemplate"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"template-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addDomain"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setRequiresPeriodicPasswordChange"),n("span",{class:"token punctuation"},"("),n("span",{class:"token boolean"},"true"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("user"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"create"),n("span",{class:"token punctuation"},"("),s("customUser"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),H={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},Z=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token comment"},"# Basic invite with admin role"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"newuser@example.com"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("admin_role"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_user_invite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("invite_user"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token comment"},"# Custom invite with specific permissions and access"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"designer@example.com"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("designer_role"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_permission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-all-templates"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_permission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"manage-template"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_template"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"template-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_domain"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("requires_periodic_password_change"),n("span",{class:"token punctuation"},"("),n("span",{class:"token boolean"},"True"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_user_invite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("invite_user"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),J={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},$=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token comment"},"// Basic invite with admin role"),s(` options `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token operator"},"&"),s("mailersend"),n("span",{class:"token punctuation"},"."),s("CreateUserOptions"),n("span",{class:"token punctuation"},"{"),s(` Email`),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string"},'"newuser@example.com"'),n("span",{class:"token punctuation"},","),s(` Role`),n("span",{class:"token punctuation"},":"),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"String"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"admin"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Create"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" options"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token comment"},"// Custom invite with specific permissions"),s(` customOptions `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token operator"},"&"),s("mailersend"),n("span",{class:"token punctuation"},"."),s("CreateUserOptions"),n("span",{class:"token punctuation"},"{"),s(` Email`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token string"},'"designer@example.com"'),n("span",{class:"token punctuation"},","),s(` Role`),n("span",{class:"token punctuation"},":"),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"String"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"designer"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},","),s(` Permissions`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token builtin"},"string"),n("span",{class:"token punctuation"},"{"),n("span",{class:"token string"},'"read-all-templates"'),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token string"},'"manage-template"'),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},","),s(` TemplateIDs`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token builtin"},"string"),n("span",{class:"token punctuation"},"{"),n("span",{class:"token string"},'"template-id"'),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},","),s(` DomainIDs`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token builtin"},"string"),n("span",{class:"token punctuation"},"{"),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},","),s(` RequiresPeriodicPasswordChange`),n("span",{class:"token punctuation"},":"),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Bool"),n("span",{class:"token punctuation"},"("),n("span",{class:"token boolean"},"true"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Create"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" customOptions"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),F={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},W=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"User")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"InviteUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Basic invite with admin role"),s(` `),n("span",{class:"token class-name"},"User"),s(" user "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"users"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"builder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"email"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"newuser@example.com"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"role"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"admin"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"createUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token comment"},"// Custom invite with specific permissions"),s(` `),n("span",{class:"token class-name"},"User"),s(" customUser "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"users"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"builder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"email"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"designer@example.com"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"role"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"designer"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-all-templates"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"manage-template"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addTemplate"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"template-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addDomain"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"requiresPeriodicPasswordChange"),n("span",{class:"token punctuation"},"("),n("span",{class:"token boolean"},"true"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"createUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("customUser"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),z={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},Y=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_user `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` `),n("span",{class:"token comment"},"# Basic invite with admin role"),s(` ms_user`),n("span",{class:"token punctuation"},"."),s("create"),n("span",{class:"token punctuation"},"("),n("span",{class:"token symbol"},"email"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"newuser@example.com"')]),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token symbol"},"role"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"admin"')]),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token comment"},"# Custom invite with specific permissions"),s(` ms_user`),n("span",{class:"token punctuation"},"."),s("create"),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token symbol"},"email"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"designer@example.com"')]),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"role"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"designer"')]),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"permissions"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"read-all-templates"')]),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"manage-template"')]),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"templates"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"template-id"')]),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"domains"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"domain-id"')]),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"requires_periodic_password_change"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token boolean"},"true"),s(` `),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Q={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},X=c(`

Responses

Response Key	Type	Details
data	object	User invite object created.

Valid

Response Code: 201 CREATED
Response Headers:
	content-type: application/json

{
    "data": {
      "id": "n3k6d1jrveq50x4v",
      "email": "user@example.com",
      "data": null,
      "permissions": ["manage-api-token", "read-filemanager"],
      "role":  "Custom User",
      "requires_periodic_password_change": false,
      "created_at": "2024-01-24T06:40:19.000000Z",
      "updated_at": "2024-01-24T06:40:19.000000Z"
    }
}

Invalid

Response Code: 422 Unprocessable Entity

`,7),nn=c(`

Update account user

If you want to update the information of an existing account user, use this PUT request:

PUT https://api.mailersend.com/v1/users/{user_id}

Request Parameters

URL parameter	Type	Required	Limitations	Details
`user_id`	`string`	yes

JSON parameters are provided in dot notation

JSON Parameter	Type	Required	Limitations	Details
`role`	`string`	yes	Must be the name of a role	View roles
`permissions`	`string[]`	yes*	Must be list of permission names	*Only required if role is a `Custom User`. View permissions
`templates`	`string[]`	no	Must be list of template IDs
`domains`	`string[]`	no	Must be list of domain IDs
`requires_periodic_password_change`	`boolean`	no

`,7),sn=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("Helpers"),n("span",{class:"token punctuation"},"\\"),s("Builder"),n("span",{class:"token punctuation"},"\\"),s("UserParams")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("Common"),n("span",{class:"token punctuation"},"\\"),s("Roles")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("Common"),n("span",{class:"token punctuation"},"\\"),s("Permissions")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"user"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"update"),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string single-quoted-string"},"'userId'"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"("),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"UserParams"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setRole"),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name static-context"},"Roles"),n("span",{class:"token operator"},"::"),n("span",{class:"token constant"},"CUSTOM_USER"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setDomains"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'domain-id'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setPermissions"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token class-name static-context"},"Permissions"),n("span",{class:"token operator"},"::"),n("span",{class:"token constant"},"READ_OWN_TEMPLATES"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"setRequiresPeriodicPasswordChange"),n("span",{class:"token punctuation"},"("),n("span",{class:"token constant boolean"},"true"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),an={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},tn=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend"),n("span",{class:"token punctuation"},","),s(" User "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" user "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setRole"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"manager"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-analytics"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-activity"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addDomain"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("user"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"update"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},","),s(" user"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),en={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},on=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("user_id"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("manager_role"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_permission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-analytics"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_permission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-activity"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("add_domain"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_user_update"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("update_user"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),cn={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},ln=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` userID `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token string"},'"user-id"'),s(` options `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token operator"},"&"),s("mailersend"),n("span",{class:"token punctuation"},"."),s("UpdateUserOptions"),n("span",{class:"token punctuation"},"{"),s(` Role`),n("span",{class:"token punctuation"},":"),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"String"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"manager"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},","),s(` Permissions`),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token builtin"},"string"),n("span",{class:"token punctuation"},"{"),n("span",{class:"token string"},'"read-analytics"'),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token string"},'"read-activity"'),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},","),s(` DomainIDs`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token builtin"},"string"),n("span",{class:"token punctuation"},"{"),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Update"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" userID"),n("span",{class:"token punctuation"},","),s(" options"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),pn={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},un=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"User")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"UpdateUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"User"),s(" user "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"users"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"builder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"role"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"manager"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-analytics"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addPermission"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"read-activity"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"addDomain"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"domain-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"updateUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("user"),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),rn={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},dn=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_user `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_user`),n("span",{class:"token punctuation"},"."),s("update"),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"user-id"')]),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"role"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"manager"')]),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"permissions"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"read-analytics"')]),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"read-activity"')]),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token symbol"},"domains"),n("span",{class:"token operator"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"domain-id"')]),n("span",{class:"token punctuation"},"]"),s(` `),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),kn={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},mn=c(`

Responses

Response Key	Type	Details
data	object	User object updated.

Valid

Response Code: 200 OK
Response Headers:
	content-type: application/json

{
  "data": {
    "id": "4k386zo42j07xv52",
    "avatar": null,
    "email": "user@example.com",
    "last_name": "User",
    "name": "User",
    "2fa": false,
    "created_at": "2024-01-22T09:35:04.000000Z",
    "updated_at": "2024-01-22T23:40:44.000000Z",
    "role": "Manager"
  }
}

Invalid

Response Code: 422 Unprocessable Entity

`,7),vn=c(`

Delete a user from account

If you want to delete a user from account, use this DELETE request:

DELETE https://api.mailersend.com/v1/users/{user_id}

Request parameters

URL parameter	Type	Required	Limitations	Details
`user_id`	`string`	yes

`,5),bn=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"user"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"delete"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'userId'"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),gn={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},hn=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("user"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"delete"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),yn={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},fn=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("user_id"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_user_delete"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("delete_user"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),_n={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},qn=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` userID `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token string"},'"user-id"'),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Delete"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" userID"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),wn={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},xn=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"DeleteUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"users"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"deleteUser"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"user-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"User deleted successfully"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Mn={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},Sn=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_user `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"User"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_user`),n("span",{class:"token punctuation"},"."),s("delete"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"user-id"')]),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),jn={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},Pn=c(`

Responses

Valid

Response Code: 200 OK

Error

Response Code: 404 Not Found

Get a list of invites

Retrieve information about account invited users with this GET request:

GET https://api.mailersend.com/v1/invites

`,8),Un=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"invite"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"getAll"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Tn={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},In=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"list"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Rn={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},Cn=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("page"),n("span",{class:"token punctuation"},"("),n("span",{class:"token number"},"1"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("limit"),n("span",{class:"token punctuation"},"("),n("span",{class:"token number"},"25"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_invites_list"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("list_invites"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),En={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},An=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` options `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token operator"},"&"),s("mailersend"),n("span",{class:"token punctuation"},"."),s("ListInviteOptions"),n("span",{class:"token punctuation"},"{"),s(` Page`),n("span",{class:"token punctuation"},":"),s(" "),n("span",{class:"token number"},"1"),n("span",{class:"token punctuation"},","),s(` Limit`),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token number"},"25"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"List"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" options"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Dn={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},Kn=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("invites"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"Invite")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("invites"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"InvitesList")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"ListInvites"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"InvitesList"),s(" list "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"invites"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"getInvites"),n("span",{class:"token punctuation"},"("),n("span",{class:"token number"},"1"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"25"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"for"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"Invite"),s(" invite "),n("span",{class:"token operator"},":"),s(" list"),n("span",{class:"token punctuation"},"."),s("invites"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("invite"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("invite"),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Bn={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},Nn=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_invite `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_invite`),n("span",{class:"token punctuation"},"."),s(`list `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Ln={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},Vn=c(`

Responses

Valid

Response Code: 200 OK
Response Headers:
	content-type: application/json

{
  "data": [
    {
      "id": "dle1krod2jvn8gwm",
      "email": "user@example.com",
      "data": {
        "domains": ["n3k6d1jrveq50x4v"],
        "templates": ["0z76k5jg0o3yeg2d"]
      },
      "role": "Custom User",
      "permissions": ["read-own-templates"],
      "requires_periodic_password_change": true,
      "created_at": "2024-04-25T17:09:23.000000Z",
      "updated_at": "2024-04-25T17:09:23.000000Z"
    }
  ]
}

Error

Response Code: 404 Not Found

Get a single invite

If you want to retrieve a single invite, use this GET request:

GET https://api.mailersend.com/v1/invites/{invite_id}

Request parameters

URL parameter	Type	Required	Limitations	Details
`invite_id`	`string`	yes

`,11),Gn=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"invite"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"find"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'inviteId'"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),On={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},Hn=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"single"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Zn={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},Jn=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("invite_id"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_invite_get"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("get_invite"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),$n={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},Fn=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` inviteID `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token string"},'"invite-id"'),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Get"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" inviteID"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Wn={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},zn=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("invites"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"Invite")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"GetInvite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"Invite"),s(" invite "),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"invites"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"getInvite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("invite"),n("span",{class:"token punctuation"},"."),s("id"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),s("invite"),n("span",{class:"token punctuation"},"."),s("email"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Yn={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},Qn=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_invite `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_invite`),n("span",{class:"token punctuation"},"."),s("get"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"invite-id"')]),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Xn={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},ns=c(`

Responses

Valid

Response Code: 200 OK
Response Headers:
	content-type: application/json

{
  "data": {
    "id": "dle1krod2jvn8gwm",
    "email": "test7@user.com",
    "data": {
      "domains": ["n3k6d1jrveq50x4v"],
      "templates": ["0z76k5jg0o3yeg2d"]
    },
    "role": "Custom User",
    "permissions": ["read-own-templates"],
    "requires_periodic_password_change": true,
    "created_at": "2024-04-25T17:09:23.000000Z",
    "updated_at": "2024-04-25T17:09:23.000000Z"
  }
}

Resend an invite

If you want to resend a user invite, use this POST request:

POST https://api.mailersend.com/v1/invites/{invite_id}/resend

Request parameters

URL parameter	Type	Required	Limitations	Details
`invite_id`	`string`	yes

`,9),ss=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"invite"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"resend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'inviteId'"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),as={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},ts=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"resend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),es={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},os=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("invite_id"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_invite_resend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("resend_invite"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),cs={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},ls=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` inviteID `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token string"},'"invite-id"'),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Resend"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" inviteID"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),ps={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},is=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"ResendInvite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"invites"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"resendInvite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"Invite resent successfully"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),us={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},rs=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_invite `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_invite`),n("span",{class:"token punctuation"},"."),s("resend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"invite-id"')]),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),ds={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},ks=c(`

Responses

Valid

Response Code: 200 OK
Response Headers:
	content-type: application/json

{
  "data": {
    "id": "dle1krod2jvn8gwm",
    "email": "test7@user.com",
    "data": {
      "domains": ["n3k6d1jrveq50x4v"],
      "templates": ["0z76k5jg0o3yeg2d"]
    },
    "role": "Custom User",
    "permissions": ["read-own-templates"],
    "requires_periodic_password_change": true,
    "created_at": "2024-04-25T17:09:23.000000Z",
    "updated_at": "2024-04-25T17:09:23.000000Z"
  }
}

Error

Response Code: 404 Not Found

Cancel an invite

If you want to cancel a user invite from account, use this DELETE request:

DELETE https://api.mailersend.com/v1/invites/{invite_id}

Request parameters

URL parameter	Type	Required	Limitations	Details
`invite_id`	`string`	yes

`,11),ms=n("div",{class:"language-php line-numbers-mode","data-ext":"php"},[n("pre",{class:"language-php"},[n("code",null,[n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("MailerSend"),n("span",{class:"token punctuation"},"\\"),s("MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),s(),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'api_key'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token string single-quoted-string"},"'key'"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token variable"},"$mailersend"),n("span",{class:"token operator"},"->"),n("span",{class:"token property"},"invite"),n("span",{class:"token operator"},"->"),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string single-quoted-string"},"'inviteId'"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),vs={href:"https://github.com/mailersend/mailersend-php",target:"_blank",rel:"noopener noreferrer"},bs=n("div",{class:"language-javascript line-numbers-mode","data-ext":"js"},[n("pre",{class:"language-javascript"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token string"},"'dotenv/config'"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"{"),s(" MailerSend "),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"from"),s(),n("span",{class:"token string"},'"mailersend"'),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"const"),s(" mailerSend "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token literal-property property"},"apiKey"),n("span",{class:"token operator"},":"),s(" process"),n("span",{class:"token punctuation"},"."),s("env"),n("span",{class:"token punctuation"},"."),n("span",{class:"token constant"},"API_KEY"),n("span",{class:"token punctuation"},","),s(` `),n("span",{class:"token punctuation"},"}"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` mailerSend`),n("span",{class:"token punctuation"},"."),s("invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"then"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"response"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("response"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"catch"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},"("),n("span",{class:"token parameter"},"error"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token operator"},"=>"),s(" console"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"log"),n("span",{class:"token punctuation"},"("),s("error"),n("span",{class:"token punctuation"},"."),s("body"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),gs={href:"https://github.com/mailersend/mailersend-nodejs",target:"_blank",rel:"noopener noreferrer"},hs=n("div",{class:"language-python line-numbers-mode","data-ext":"py"},[n("pre",{class:"language-python"},[n("code",null,[n("span",{class:"token keyword"},"from"),s(" mailersend "),n("span",{class:"token keyword"},"import"),s(" MailerSendClient"),n("span",{class:"token punctuation"},","),s(` UsersBuilder ms `),n("span",{class:"token operator"},"="),s(" MailerSendClient"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` request `),n("span",{class:"token operator"},"="),s(),n("span",{class:"token punctuation"},"("),s("UsersBuilder"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("invite_id"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"."),s("build_invite_cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},")"),s(` response `),n("span",{class:"token operator"},"="),s(" ms"),n("span",{class:"token punctuation"},"."),s("users"),n("span",{class:"token punctuation"},"."),s("cancel_invite"),n("span",{class:"token punctuation"},"("),s("request"),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),ys={href:"https://github.com/mailersend/mailersend-python",target:"_blank",rel:"noopener noreferrer"},fs=n("div",{class:"language-go line-numbers-mode","data-ext":"go"},[n("pre",{class:"language-go"},[n("code",null,[n("span",{class:"token keyword"},"package"),s(` main `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token punctuation"},"("),s(` `),n("span",{class:"token string"},'"context"'),s(` `),n("span",{class:"token string"},'"log"'),s(` `),n("span",{class:"token string"},'"time"'),s(` `),n("span",{class:"token string"},'"github.com/mailersend/mailersend-go"'),s(` `),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"var"),s(" APIKey "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token string"},'"Api Key Here"'),s(` `),n("span",{class:"token keyword"},"func"),s(),n("span",{class:"token function"},"main"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token comment"},"// Create an instance of the mailersend client"),s(` ms `),n("span",{class:"token operator"},":="),s(" mailersend"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"NewMailersend"),n("span",{class:"token punctuation"},"("),s("APIKey"),n("span",{class:"token punctuation"},")"),s(` ctx `),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Background"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` ctx`),n("span",{class:"token punctuation"},","),s(" cancel "),n("span",{class:"token operator"},":="),s(" context"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"WithTimeout"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token number"},"5"),n("span",{class:"token operator"},"*"),s("time"),n("span",{class:"token punctuation"},"."),s("Second"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"defer"),s(),n("span",{class:"token function"},"cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(` inviteID `),n("span",{class:"token operator"},":="),s(),n("span",{class:"token string"},'"invite-id"'),s(` `),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token boolean"},"_"),n("span",{class:"token punctuation"},","),s(" err "),n("span",{class:"token operator"},":="),s(" ms"),n("span",{class:"token punctuation"},"."),s("Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Cancel"),n("span",{class:"token punctuation"},"("),s("ctx"),n("span",{class:"token punctuation"},","),s(" inviteID"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token keyword"},"if"),s(" err "),n("span",{class:"token operator"},"!="),s(),n("span",{class:"token boolean"},"nil"),s(),n("span",{class:"token punctuation"},"{"),s(` log`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"Fatal"),n("span",{class:"token punctuation"},"("),s("err"),n("span",{class:"token punctuation"},")"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),_s={href:"https://github.com/mailersend/mailersend-go",target:"_blank",rel:"noopener noreferrer"},qs=n("div",{class:"language-java line-numbers-mode","data-ext":"java"},[n("pre",{class:"language-java"},[n("code",null,[n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSend")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"import"),s(),n("span",{class:"token import"},[n("span",{class:"token namespace"},[s("com"),n("span",{class:"token punctuation"},"."),s("mailersend"),n("span",{class:"token punctuation"},"."),s("sdk"),n("span",{class:"token punctuation"},"."),s("exceptions"),n("span",{class:"token punctuation"},".")]),n("span",{class:"token class-name"},"MailerSendException")]),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"void"),s(),n("span",{class:"token class-name"},"CancelInvite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` `),n("span",{class:"token class-name"},"MailerSend"),s(" ms "),n("span",{class:"token operator"},"="),s(),n("span",{class:"token keyword"},"new"),s(),n("span",{class:"token class-name"},"MailerSend"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"setToken"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"api token"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token keyword"},"try"),s(),n("span",{class:"token punctuation"},"{"),s(` ms`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"invites"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"cancelInvite"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"invite-id"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token class-name"},"System"),n("span",{class:"token punctuation"},"."),s("out"),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"println"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string"},'"Invite cancelled successfully"'),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(),n("span",{class:"token keyword"},"catch"),s(),n("span",{class:"token punctuation"},"("),n("span",{class:"token class-name"},"MailerSendException"),s(" e"),n("span",{class:"token punctuation"},")"),s(),n("span",{class:"token punctuation"},"{"),s(` e`),n("span",{class:"token punctuation"},"."),n("span",{class:"token function"},"printStackTrace"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),n("span",{class:"token punctuation"},";"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `),n("span",{class:"token punctuation"},"}"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),ws={href:"https://github.com/mailersend/mailersend-java",target:"_blank",rel:"noopener noreferrer"},xs=n("div",{class:"language-ruby line-numbers-mode","data-ext":"rb"},[n("pre",{class:"language-ruby"},[n("code",null,[n("span",{class:"token keyword"},"require"),s(),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"mailersend-ruby"')]),s(` ms_invite `),n("span",{class:"token operator"},"="),s(" Mailersend"),n("span",{class:"token double-colon punctuation"},"::"),n("span",{class:"token class-name"},"Invite"),n("span",{class:"token punctuation"},"."),n("span",{class:"token keyword"},"new"),s(` ms_invite`),n("span",{class:"token punctuation"},"."),s("cancel"),n("span",{class:"token punctuation"},"("),n("span",{class:"token string-literal"},[n("span",{class:"token string"},'"invite-id"')]),n("span",{class:"token punctuation"},")"),s(` `)])]),n("div",{class:"line-numbers","aria-hidden":"true"},[n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"}),n("div",{class:"line-number"})])],-1),Ms={href:"https://github.com/mailersend/mailersend-ruby",target:"_blank",rel:"noopener noreferrer"},Ss=c(`

Responses

Valid

Response Code: 204 OK

Error

Response Code: 404 Not Found

Roles

Name	Description
Admin	Administrator has full access and can perform all actions in the account.
Manager	Has full access, access API and billing.
Designer	Designers can only view and create templates.
Accountant	Can only manage payments and access invoices.
Custom User	Select the sections of your account that the user should have access to.

Permissions

Name	Description	Group
read-all-templates	View all templates	Templates
read-own-templates	View specific templates	Templates
manage-template	Manage templates	Templates
read-filemanager	View the file manager	Templates
manage-domain	Manage domain	Domains
manage-inbound	Manage inbound routes	Domains
manage-webhook	Manage webhooks	Domains
control-sendings	Control sendings	Domains
control-tracking-options	Control tracking option	Domains
access-smtp-credentials	Access SMTP credentials	Domains
view-smtp-users	View SMTP users	Domains
manage-smtp-users	Manage SMTP users	Domains
read-recipient	View recipients	Recipient
read-activity	View email activity	Activity
read-email	View email content	Activity
read-analytics	View email analytics	Analytics
read-sender-identities	View sender identities	Sender identities
manage-sender-identities	Manage sender identities	Sender identities
read-email-verification	View email verifications lists	Email verification
manage-email-verification	Manage email verification lists	Email verification
manage-sms	Manage numbers	SMS
read-sms	View SMS activity	SMS
manage-verified-recipients	Manage verified recipients	SMS
view-sms-webhooks	View number webhooks	SMS
manage-sms-webhooks	Manage number webhooks	SMS
view-sms-inbound	View number inbound routes	SMS
manage-sms-inbound	Manage number inbound routes	SMS
update-plan	Manage plans	Plan and Billing
manage-account	Edit account settings	Plan and Billing
read-invoice	View invoices	Account settings
manage-api-token	Manage API tokens	Account settings
read-suppressions	View suppressions lists	Account settings
manage-suppressions	Manage suppressions	Account settings
read-ip-addresses	View IP allowlist	Account settings
manage-ip-addresses	Manage IP allowlist	Account settings
read-error-log	View error log	Account settings

`,9);function js(Ps,Us){const e=p("ExternalLinkIcon"),o=p("CodeGroupItem"),l=p("CodeGroup"),i=p("RouterLink");return r(),d("div",null,[m,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[v,n("p",null,[n("a",b,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[g,n("p",null,[n("a",h,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[y,n("p",null,[n("a",f,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[_,n("p",null,[n("a",q,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[w,n("p",null,[n("a",x,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[M,n("p",null,[n("a",S,[s("More examples"),a(e)])])]),_:1})]),_:1}),j,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[P,n("p",null,[n("a",U,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[T,n("p",null,[n("a",I,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[R,n("p",null,[n("a",C,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[E,n("p",null,[n("a",A,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[D,n("p",null,[n("a",K,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[B,n("p",null,[n("a",N,[s("More examples"),a(e)])])]),_:1})]),_:1}),L,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[V,n("p",null,[n("a",G,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[O,n("p",null,[n("a",H,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[Z,n("p",null,[n("a",J,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[$,n("p",null,[n("a",F,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[W,n("p",null,[n("a",z,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[Y,n("p",null,[n("a",Q,[s("More examples"),a(e)])])]),_:1})]),_:1}),X,n("p",null,[n("em",null,[s("See - "),a(i,{to:"/general.html#validation-errors"},{default:t(()=>[s("Validation errors")]),_:1})])]),nn,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[sn,n("p",null,[n("a",an,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[tn,n("p",null,[n("a",en,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[on,n("p",null,[n("a",cn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[ln,n("p",null,[n("a",pn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[un,n("p",null,[n("a",rn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[dn,n("p",null,[n("a",kn,[s("More examples"),a(e)])])]),_:1})]),_:1}),mn,n("p",null,[n("em",null,[s("See - "),a(i,{to:"/general.html#validation-errors"},{default:t(()=>[s("Validation errors")]),_:1})])]),vn,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[bn,n("p",null,[n("a",gn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[hn,n("p",null,[n("a",yn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[fn,n("p",null,[n("a",_n,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[qn,n("p",null,[n("a",wn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[xn,n("p",null,[n("a",Mn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[Sn,n("p",null,[n("a",jn,[s("More examples"),a(e)])])]),_:1})]),_:1}),Pn,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[Un,n("p",null,[n("a",Tn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[In,n("p",null,[n("a",Rn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[Cn,n("p",null,[n("a",En,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[An,n("p",null,[n("a",Dn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[Kn,n("p",null,[n("a",Bn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[Nn,n("p",null,[n("a",Ln,[s("More examples"),a(e)])])]),_:1})]),_:1}),Vn,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[Gn,n("p",null,[n("a",On,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[Hn,n("p",null,[n("a",Zn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[Jn,n("p",null,[n("a",$n,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[Fn,n("p",null,[n("a",Wn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[zn,n("p",null,[n("a",Yn,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[Qn,n("p",null,[n("a",Xn,[s("More examples"),a(e)])])]),_:1})]),_:1}),ns,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[ss,n("p",null,[n("a",as,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[ts,n("p",null,[n("a",es,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[os,n("p",null,[n("a",cs,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[ls,n("p",null,[n("a",ps,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[is,n("p",null,[n("a",us,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[rs,n("p",null,[n("a",ds,[s("More examples"),a(e)])])]),_:1})]),_:1}),ks,a(l,null,{default:t(()=>[a(o,{title:"PHP"},{default:t(()=>[ms,n("p",null,[n("a",vs,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"NodeJS"},{default:t(()=>[bs,n("p",null,[n("a",gs,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Python"},{default:t(()=>[hs,n("p",null,[n("a",ys,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Go"},{default:t(()=>[fs,n("p",null,[n("a",_s,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Java"},{default:t(()=>[qs,n("p",null,[n("a",ws,[s("More examples"),a(e)])])]),_:1}),a(o,{title:"Ruby"},{default:t(()=>[xs,n("p",null,[n("a",Ms,[s("More examples"),a(e)])])]),_:1})]),_:1}),Ss])}const Is=u(k,[["render",js],["__file","users.html.vue"]]);export{Is as default};

# Users

# Get a list of account users

# Responses

# Valid

# Error

# Get a single account user

# Request parameters

# Responses

# Valid

# Error

# Invite a user to account

# Request Parameters

# Responses

# Valid

# Invalid

# Update account user

# Request Parameters

# Responses

# Valid

# Invalid

# Delete a user from account

# Request parameters

# Responses

# Valid

# Error

# Get a list of invites

# Responses

# Valid

# Error

# Get a single invite

# Request parameters

# Responses

# Valid

# Resend an invite

# Request parameters

# Responses

# Valid

# Error

# Cancel an invite

# Request parameters

# Responses

# Valid

# Error

# Roles

# Permissions

Users

Get a list of account users

Responses

Valid

Error

Get a single account user

Request parameters

Responses

Valid

Error

Invite a user to account

Request Parameters

Responses

Valid

Invalid

Update account user

Request Parameters

Responses

Valid

Invalid

Delete a user from account

Request parameters

Responses

Valid

Error

Get a list of invites

Responses

Valid

Error

Get a single invite

Request parameters

Responses

Valid

Resend an invite

Request parameters

Responses

Valid

Error

Cancel an invite

Request parameters

Responses

Valid

Error

Roles

Permissions