Sender profiles

Manage email sender identities

List Profiles

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

idintegerRequired

profile_namestringRequired

display_namestringRequired

emailstring · emailRequired

get

/api/profiles

HTTPcURLJavaScriptPython

GET /api/profiles HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "profile_name": "text",
    "display_name": "text",
    "email": "[e-mail]"
  }
]

Create Profile

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

profile_namestringRequired

display_namestringRequired

emailstring · emailRequired

passwordstringRequired

Responses

200

Successful Response

application/json

idintegerRequired

profile_namestringRequired

display_namestringRequired

emailstring · emailRequired

422

Validation Error

application/json

post

/api/profiles

HTTPcURLJavaScriptPython

POST /api/profiles HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "profile_name": "text",
  "display_name": "text",
  "email": "[e-mail]",
  "password": "text"
}

{
  "id": 1,
  "profile_name": "text",
  "display_name": "text",
  "email": "[e-mail]"
}

Update Profile

put

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

profile_idintegerRequired

Body

application/json

profile_nameany ofOptional

stringOptional

or

nullOptional

display_nameany ofOptional

stringOptional

or

nullOptional

emailany ofOptional

string · emailOptional

or

nullOptional

passwordany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

idintegerRequired

profile_namestringRequired

display_namestringRequired

emailstring · emailRequired

422

Validation Error

application/json

put

/api/profiles/{profile_id}

HTTPcURLJavaScriptPython

PUT /api/profiles/{profile_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "profile_name": "text",
  "display_name": "text",
  "email": "[e-mail]",
  "password": "text"
}

{
  "id": 1,
  "profile_name": "text",
  "display_name": "text",
  "email": "[e-mail]"
}

Delete Profile

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

profile_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/api/profiles/{profile_id}

HTTPcURLJavaScriptPython

DELETE /api/profiles/{profile_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Duplicate Profile

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

profile_idintegerRequired

Body

application/json

profile_namestringRequired

Responses

200

Successful Response

application/json

idintegerRequired

profile_namestringRequired

display_namestringRequired

emailstring · emailRequired

422

Validation Error

application/json

post

/api/profiles/{profile_id}/duplicate

HTTPcURLJavaScriptPython

POST /api/profiles/{profile_id}/duplicate HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "profile_name": "text"
}

{
  "id": 1,
  "profile_name": "text",
  "display_name": "text",
  "email": "[e-mail]"
}