Release pool domains
Returns every domain in a reservation to your pool when a customer
cancels. By default they come back on the next monthly date; pass
forced: true to take them back now. Billing on the source order
is unchanged. A live reservation that used forwarding_url requires
the pool recycle forwarding URL configured by Peeker during production
setup. Sandbox supplies a local recycle target automatically.
POST
/
pool
/
release
Release pool domains
curl --request POST \
--url https://api.peeker.ai/partner/v1/pool/release \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reservation_id": "<string>"
}
'{
"data": {
"id": "prl_01HZX0PR1A2B3C4D5E6F7G8H",
"reservation_id": "pcl_01HZX0PC1A2B3C4D5E6F7G8H",
"status": "scheduled",
"step": "<string>",
"domain_count": 2,
"inbox_count": 2,
"effective_at": "2023-11-07T05:31:56Z",
"forced": true,
"rewarming_domain_count": 1,
"quarantined_domain_count": 1,
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
}{
"data": {
"id": "prl_01HZX0PR1A2B3C4D5E6F7G8H",
"reservation_id": "pcl_01HZX0PC1A2B3C4D5E6F7G8H",
"status": "scheduled",
"step": "<string>",
"domain_count": 2,
"inbox_count": 2,
"effective_at": "2023-11-07T05:31:56Z",
"forced": true,
"rewarming_domain_count": 1,
"quarantined_domain_count": 1,
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
}{
"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": {}
}
}{
"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
Durable pool release state.
Show child attributes
Show child attributes
Last modified on August 25, 2026
⌘I
Release pool domains
curl --request POST \
--url https://api.peeker.ai/partner/v1/pool/release \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reservation_id": "<string>"
}
'{
"data": {
"id": "prl_01HZX0PR1A2B3C4D5E6F7G8H",
"reservation_id": "pcl_01HZX0PC1A2B3C4D5E6F7G8H",
"status": "scheduled",
"step": "<string>",
"domain_count": 2,
"inbox_count": 2,
"effective_at": "2023-11-07T05:31:56Z",
"forced": true,
"rewarming_domain_count": 1,
"quarantined_domain_count": 1,
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
}{
"data": {
"id": "prl_01HZX0PR1A2B3C4D5E6F7G8H",
"reservation_id": "pcl_01HZX0PC1A2B3C4D5E6F7G8H",
"status": "scheduled",
"step": "<string>",
"domain_count": 2,
"inbox_count": 2,
"effective_at": "2023-11-07T05:31:56Z",
"forced": true,
"rewarming_domain_count": 1,
"quarantined_domain_count": 1,
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
}{
"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": {}
}
}{
"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": {}
}
}