{"info":{"_postman_id":"bfa793d5-7a92-4541-bf3d-0b2e08b397f9","name":"Promotable User API","description":"

This documentation describes API for promotable user creation on StartWire. The API creates specific type of users on StartWire who will be converted to usual type of users after passing validation procedures. The API is to be used by partners of StartWire.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2720644","collectionId":"bfa793d5-7a92-4541-bf3d-0b2e08b397f9","publishedId":"RWMJqSQj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-07-25T19:59:26.000Z"},"item":[{"name":"Create Promotable User","id":"36244a93-d538-448a-aab2-5229091ba4e0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"source\":\"test\",\n\t\"email\":\"great_software_engineer@example.com\",\n\t\"first_name\": \"Test\",\n\t\"last_name\":\"User\",\n\t\"zip_code\":\"10101\",\n\t\"target_title\":\"Software engineer\",\n\t\"keywords\": \"API implementation\",\n\t\"resume\": \"url to resume\"\n}"},"url":"https://www.startwire.com/api/registration/promotable.json","description":"

Creates promotable user on StartWire based on information sent via POST request. List of parameters will be described below.\nAfter creation promotable user we run validation procedures which check that at least email is valid.

The POST request should be made to the endpoint mentioned above and the BODY of request should contain parameters in a form of JSON data.

Parameters

The BODY of request should contain parameters in a form of JSON data.

source (required) — an identifier of StartWire partner;
email (required) — user's email,
first_name (required) — user's firstname,
last_name (required) — user's lastname,
zip_code (required) — user's zipcode,
target_title (required) — user's job title. A list of available job titles should be approved by StartWire team;
keywords (optional) — user's job search keywords,
resume (optional) — url to user's resume.

Responses

You get HTTP 200 Success response if we haven't had a user on our side yet. If we have already had a user on our side you get \na message 'User already exists'. Detailed responses description is described below.

HTTP 200 Success\nThe submitted data has been successfully accepted.
HTTP 400 Bad Request\nThe submitted data in invalid. Please check error messages in a response.
HTTP 401 User already exists\nThe user has already created on StartWire.
HTTP 402 Duplicate request\nYou have already sumbitted this data earlier.
HTTP 500 Internal Error\nSomething went wrong. Please let us know about it.

\n","urlObject":{"protocol":"https","path":["api","registration","promotable.json"],"host":["www","startwire","com"],"query":[],"variable":[]}},"response":[{"id":"608e7846-43e4-456e-be84-cecb9e894d5e","name":"User already exists","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"source\":\"test\",\n\t\"email\":\"great_software_engineer@example.com\",\n\t\"first_name\": \"Test\",\n\t\"last_name\":\"User\",\n\t\"zip_code\":\"10101\",\n\t\"target_title\":\"Software engineer\",\n\t\"keywords\": \"API implementation\",\n\t\"resume\": \"url to resume\"\n}"},"url":"https://www.startwire.com/api/registration/promotable.json"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Mon, 23 Jul 2018 08:35:11 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Set-Cookie","value":"ahoy_visit=2a79a321-17db-47c0-be88-f80810390af8; domain=.startwire.com; path=/; expires=Mon, 23 Jul 2018 09:05:11 -0000","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Set-Cookie","value":"ahoy_track=true; path=/","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"5fb34341-6c18-49b1-a0ab-cf4c7400e4b3","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.046833","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Mon Jul 20 2020 12:55:12 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"startwire.com","path":"/","secure":false,"value":"fbbc6289-790b-4c20-8c3d-ddf8c1f8413d","key":"ahoy_visitor"},{"expires":"Mon Jul 23 2018 09:05:11 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"startwire.com","path":"/","secure":false,"value":"2a79a321-17db-47c0-be88-f80810390af8","key":"ahoy_visit"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"www.startwire.com","path":"/","secure":false,"value":"true","key":"ahoy_track"}],"responseTime":null,"body":"{\"status\":401,\"message\":\"User already exists\"}"},{"id":"dbf92095-8f1f-4d78-aeb3-851d9df71627","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n\t\"source\":\"test\",\n\t\"email\":\"great_software_engineer@example.com\",\n\t\"first_name\": \"Test\",\n\t\"last_name\":\"User\",\n\t\"zip_code\":\"10101\",\n\t\"target_title\":\"Software engineer\",\n\t\"keywords\": \"API implementation\",\n\t\"resume\": \"url to resume\"\n}"},"url":"https://www.startwire.com/api/registration/promotable.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 20 Jul 2018 13:33:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"ETag","value":"W/\"b61dc2661a34bb4734d0b75efc7c5670\"","name":"ETag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Set-Cookie","value":"ahoy_visit=40bae1d8-bcdb-42a5-a7ee-2a17d9faa451; domain=.startwire.com; path=/; expires=Fri, 20 Jul 2018 14:03:39 -0000","name":"Set-Cookie","description":"an HTTP cookie"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":"The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"},{"key":"X-Frame-Options","value":"SAMEORIGIN","name":"X-Frame-Options","description":"Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"},{"key":"X-Request-Id","value":"266b95c8-5720-4199-a017-729c79d5257b","name":"X-Request-Id","description":"Custom header"},{"key":"X-Runtime","value":"0.102728","name":"X-Runtime","description":"Custom header"},{"key":"X-XSS-Protection","value":"1; mode=block","name":"X-XSS-Protection","description":"Cross-site scripting (XSS) filter"}],"cookie":[{"expires":"Mon Jul 20 2020 12:55:12 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"startwire.com","path":"/","secure":false,"value":"fbbc6289-790b-4c20-8c3d-ddf8c1f8413d","key":"ahoy_visitor"},{"expires":"Fri Jul 20 2018 14:03:39 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"startwire.com","path":"/","secure":false,"value":"40bae1d8-bcdb-42a5-a7ee-2a17d9faa451","key":"ahoy_visit"},{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":false,"domain":"www.startwire.com","path":"/","secure":false,"value":"true","key":"ahoy_track"}],"responseTime":null,"body":"{\"status\":200,\"message\":\"Success\"}"}],"_postman_id":"36244a93-d538-448a-aab2-5229091ba4e0"}]}