Create a new Email Sharing

POST /v1/email_campaigns/{campaign_id}/email_sharings

Authentication

Authentication Method API token via Authorization header

Request

Path Parameters

Parameter	Type	Required	Description	Example
`campaign_id`	string($uuid)	Yes	Campaign ID	`campaign_id`

Headers

Header	Required	Description	Example
`Content-Type`	Yes	Request content type.	`application/json`
`Authorization`	Yes	Pisano API token.	`Token token=<API_TOKEN>`

Request Body

{

"emails": [
""
],
"custom_attributes": {
"": {
"": "",
"external_id": "",
"phone_number": ""
}
},
"built_in_responses": {
"": {
"musteriDetayBilgi1": "",
"musteriDetayBilgi2": ""
}
}
}

Request Body Fields

Field	Type	Required	Description	Example
`emails[]`				`<email>`
`custom_attributes.<phone>.<name>`				`<name>`
`custom_attributes.<phone>.external_id`				`<external_id>`
`custom_attributes.<phone>.phone_number`				`<phone_number>`
`built_in_responses.<email>.musteriDetayBilgi1`				`<musteriDetayBilgi1>`
`built_in_responses.<email>.musteriDetayBilgi2`				`<musteriDetayBilgi2>`

Request Example

cURL

cURL Request Example

curl --location 'https://<pisanoEnvironment>/v1/email_campaigns/<campaignID>/email_sharings' --header 'Authorization: <token>' --header 'Content-Type: application/json' --data '{"emails":["<email>"],"custom_attributes":{},"transactional_data":{}}'

Responses

200 OK (Successful)

400 bad_request

{

"error_message": "string",
"data": "string",
"code": 0,
"errors": [
{
"code": "string",
"message": "string",
"field": "string"
}
]
}

401 Error: Unauthorized

Error Code: 13001
Error Message: Wrong authentication token

{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}

403 Error: Forbidden

Error Code: 13013
Error Message: Permission denied

{"error_message":"Permission denied","data":"Permission denied","code":13013,"errors":null}

404 Requested resource not found!

Requested resource not found!

Additional Information

Rate Limits

20 requests/5 sec; 40/25 sec; 80/125 sec; 160/625 sec. On-premise throttle rules can be adjusted or removed.

Usage Limitations

Best practice: trigger no more than 5,000 customers in a single request.

Notes

Pisano Campaing Sharing APIs - Email - Email Sharing