Create Contact
POST /customers/{customer_id}/contacts
Create a new customer contact.
Roles
Users with the following roles may access this endoint:
Dispatcher
Breaking Changes
No breaking changes.
Request
- Sample Request
- Sample Response
POST /customers/{customer_id}/contacts/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"name": "John J NewContact"
}
Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET,POST
Access-Control-Allow-Origin: *
Allow: GET,POST
Content-Length: 272
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:37:34 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: 5f46a30c-b337-49e2-b786-8d9ab4582b00
{
"email": null,
"fax": null,
"id": 107589,
"name": "John J NewContact",
"notify_on_acknowledged_request": false,
"notify_on_completed_request": false,
"notify_on_dispatched_request": false,
"notify_on_failed_request": false,
"notify_on_new_request": false,
"number": null
}
Path Parameters
customer_id Integer, Required
Customer identifier.
Query Parameters
No query parameters.
Request Headers
Refer to StandardRequestHeadersModel for more details.
authorization String, Required
Authorization header (bearer with access token). See the Authentication Guide to get started.
- Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
- No longer than 256 characters.
- At least 1 characters long.
Content-Type String, Optional
Default Value: application/json
One of the following MIME types:
- "application/json" Refer to the JSON Spec.
x-api-version String, Optional
Request identifier.
- At least 1 and no more than 64 characters.
- Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).
x-tenant-id Integer, Required
Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.
Request Body
Refer to CreateCustomerContactModel for more details.
email String, Optional
Email address comma-separated list.
- At least 0 and no more than 256 characters.
- List of 1 or more comma-separated email addresses. Whitespace allowed (newline, space, tab).
fax String, Optional
Fax number (free text).
- At least 7 characters, not more than 15.
name String, Optional
Name (free text).
- At least 1 and no more than 128 characters.
notify_on_acknowledged_request Boolean, Optional
Notify on acknowledge request.
- One of 0, 1, True, False (case insensitive).
notify_on_completed_request Boolean, Optional
Notify on completed request.
- One of 0, 1, True, False (case insensitive).
notify_on_dispatched_request Boolean, Optional
Notify on dispatched request.
- One of 0, 1, True, False (case insensitive).
notify_on_failed_request Boolean, Optional
Notify on failed request.
- One of 0, 1, True, False (case insensitive).
notify_on_new_request Boolean, Optional
Notify on new request.
- One of 0, 1, True, False (case insensitive).
number String, Optional
Phone number (free text).
- At least 1 and no more than 90 characters.
Response
Response Headers
Refer to StandardResponseHeadersModel for more details.
Content-Type String, Optional
Default Value: application/json
One of the following MIME types:
- "application/json" Refer to the JSON Spec.
x-api-version String
Request identifier.
- At least 1 and no more than 64 characters.
- Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).
x-request-id String
Request identifier.
- Valid UUID.
Response Body
Refer to CustomerContactModel for more details.
email String
Email address comma-separated list.
- At least 0 and no more than 256 characters.
- List of 1 or more comma-separated email addresses. Whitespace allowed (newline, space, tab).
fax String
Fax number (free text).
- At least 7 characters, not more than 15.
id Integer
Customer contact identifier.
name String
Name (free text).
- At least 1 and no more than 128 characters.
notify_on_acknowledged_request Boolean
Notify on acknowledge request.
- One of 0, 1, True, False (case insensitive).
notify_on_completed_request Boolean
Notify on completed request.
- One of 0, 1, True, False (case insensitive).
notify_on_dispatched_request Boolean
Notify on dispatched request.
- One of 0, 1, True, False (case insensitive).
notify_on_failed_request Boolean
Notify on failed request.
- One of 0, 1, True, False (case insensitive).
notify_on_new_request Boolean
Notify on new request.
- One of 0, 1, True, False (case insensitive).
number String
Phone number (free text).
- At least 1 and no more than 90 characters.
Code Samples
- cURL
- Python
- CSharp 2.0
curl --request POST --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
--data '{"name": "John J NewContact"}' \
127.0.0.1:8003/customers/{customer_id}/contacts
import requests, json
body = '''
{
"name": "John J NewContact"
}
'''
response = requests.post(
'http://localhost:8003/customers/{customer_id}/contacts',
headers={
'Authorization': 'Bearer {your-auth-token}',
'Content-Type': 'application/json',
'x-tenant-id': '{your-tenant-id}'
},
params={
},
data=body
)
results = json.loads(response.text)
print(results)
using System;
using System.Net;
using System.Collections.Specialized;
namespace CROSoftware
{
public class DemoClient
{
static public void Main ()
{
WebClient client = new WebClient();
// URL
String url = "/customers/{customer_id}/contacts";
// Headers
client.Headers.Add("Authorization", "Bearer {your-auth-token}");
client.Headers.Add("Content-Type", "application/json");
client.Headers.Add("x-tenant-id", "{your-tenant-id}");
// Body
String body = "{\"name\": \"John J NewContact\"}";
String json = client.UploadString(url, "post", body);
Console.WriteLine(json);
}
}
}