Rename inbox senders
Keeps the domain; regenerates mailbox names from new personas.
Only first_name and last_name change mailbox identities.
POST
/
swaps
/
user_names
Rename inbox senders
curl --request POST \
--url https://api.peeker.ai/partner/v1/swaps/user_names \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain_id": "<string>",
"personas": [
{
"first_name": "<string>",
"last_name": "<string>",
"profile_picture_url": "<string>"
}
]
}
'{
"data": {
"swaps": [
{
"id": "swp_01HZX0SW4A2B3C4D5E6F7G8H",
"type": "user_names",
"domain_id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
"replacement_domain": null,
"status": "in_progress",
"created_at": "2026-05-08T12:00:00Z"
}
]
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}Authorizations
Partner API key (pk_live_… or pk_test_…).
Body
application/json
Response
Accepted user-name swaps.
Show child attributes
Show child attributes
Last modified on August 25, 2026
⌘I
Rename inbox senders
curl --request POST \
--url https://api.peeker.ai/partner/v1/swaps/user_names \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain_id": "<string>",
"personas": [
{
"first_name": "<string>",
"last_name": "<string>",
"profile_picture_url": "<string>"
}
]
}
'{
"data": {
"swaps": [
{
"id": "swp_01HZX0SW4A2B3C4D5E6F7G8H",
"type": "user_names",
"domain_id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
"replacement_domain": null,
"status": "in_progress",
"created_at": "2026-05-08T12:00:00Z"
}
]
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}{
"error": {
"code": "emailbison_super_admin_key",
"message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"field": "credentials.api_key",
"details": {}
}
}