--- updatedAt: 2025-09-10T20:59:32.000Z agentTools: projectIndex: https://shipcars.readme.io/llms.txt --- # Add a new contact This method adds a new contact to the contact book of the current user # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "User Management", "description": "Ship.Cars User Management", "contact": { "url": "https://ship.cars", "email": "support@ship.cars" }, "version": "1.0.0" }, "components": { "securitySchemes": { "bearerAuth": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token", "scopes": {} } } } } }, "servers": [ { "url": "https://ship.cars/api" } ], "paths": { "/shipperlite/posting/v3/contacts": { "post": { "tags": [ "Contacts API" ], "summary": "Add a new contact", "description": "This method adds a new contact to the contact book of the current user", "operationId": "addContact", "requestBody": { "content": { "application/json": { "schema": { "required": [ "name", "primaryPhone" ], "type": "object", "properties": { "id": { "type": "string", "description": "Internal ID of the contact.", "example": "YK41K" }, "companyName": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "Formal name of the company.", "example": "Martin LLC" }, "email": { "maxLength": 254, "minLength": 0, "type": "string", "description": "Email address.", "example": "email@email.com" }, "name": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "Name(s) of the person.", "example": "Martin Fuller" }, "primaryPhone": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Required primary phone used for contacting.", "example": "1234567890" }, "primaryPhoneNotes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Notes related to the primary phone, if applicable.", "example": "Do not call me before 8" }, "secondaryPhone": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Secondary phone used for contacting, if applicable.", "example": "1234567890" }, "secondaryPhoneNotes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Notes related to the secondary phone, if applicable.", "example": "Do not call me before 8" }, "thirdPhone": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Third phone used for contacting, if applicable.", "example": "1234567890" }, "thirdPhoneNotes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Notes related to the third phone, if applicable.", "example": "Do not call me before 8" }, "workingHours": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Official working hours of the company/entity", "example": "From 5 to 12" }, "location": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal ID of the location", "example": "YK41K" }, "street": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$", "type": "string", "description": "Street", "example": "161 W Cherry St" }, "city": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "City", "example": "Albion" }, "state": { "pattern": "^{0}|[a-zA-Z]{2}$", "type": "string", "description": "Two-letter abbreviation of the state", "example": "IL", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "zipCode": { "pattern": "^{0}|\\d{5}(-\\d{4})?$", "type": "string", "description": "Required US postal code of the area or district", "example": "62806" }, "locationId": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "Custom pickup location ID as set by the customer, if applicable", "example": "XC223" } }, "description": "Required location information." }, "type": { "type": "string", "description": "Contact type", "example": "CUSTOMER", "enum": [ "CUSTOMER", "PICKUP", "DELIVERY" ] }, "notes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Contact notes, if applicable.", "example": "Located in building A-C1" } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "required": [ "name", "primaryPhone" ], "type": "object", "properties": { "id": { "type": "string", "description": "Internal ID of the contact.", "example": "YK41K" }, "companyName": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "Formal name of the company.", "example": "Martin LLC" }, "email": { "maxLength": 254, "minLength": 0, "type": "string", "description": "Email address.", "example": "email@email.com" }, "name": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "Name(s) of the person.", "example": "Martin Fuller" }, "primaryPhone": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Required primary phone used for contacting.", "example": "1234567890" }, "primaryPhoneNotes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Notes related to the primary phone, if applicable.", "example": "Do not call me before 8" }, "secondaryPhone": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Secondary phone used for contacting, if applicable.", "example": "1234567890" }, "secondaryPhoneNotes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Notes related to the secondary phone, if applicable.", "example": "Do not call me before 8" }, "thirdPhone": { "pattern": "^{0}|(\\+?1[ -]?)?\\(?\\d{3}\\)?[ -]?\\d{3}[ -]?\\d{4}$", "type": "string", "description": "Third phone used for contacting, if applicable.", "example": "1234567890" }, "thirdPhoneNotes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Notes related to the third phone, if applicable.", "example": "Do not call me before 8" }, "workingHours": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Official working hours of the company/entity", "example": "From 5 to 12" }, "location": { "type": "object", "properties": { "id": { "type": "string", "description": "Internal ID of the location", "example": "YK41K" }, "street": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$", "type": "string", "description": "Street", "example": "161 W Cherry St" }, "city": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "City", "example": "Albion" }, "state": { "pattern": "^{0}|[a-zA-Z]{2}$", "type": "string", "description": "Two-letter abbreviation of the state", "example": "IL", "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ] }, "zipCode": { "pattern": "^{0}|\\d{5}(-\\d{4})?$", "type": "string", "description": "Required US postal code of the area or district", "example": "62806" }, "locationId": { "pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$", "type": "string", "description": "Custom pickup location ID as set by the customer, if applicable", "example": "XC223" } }, "description": "Required location information." }, "type": { "type": "string", "description": "Contact type", "example": "CUSTOMER", "enum": [ "CUSTOMER", "PICKUP", "DELIVERY" ] }, "notes": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Contact notes, if applicable.", "example": "Located in building A-C1" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "httpStatus": { "type": "integer", "format": "int32" }, "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "errorDetails": { "type": "array", "items": { "type": "string" } } } } } } } }, "security": [ { "bearerAuth": [] } ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```